Timing API

https://web.timingapp.com/docs/
Admin
Timing API is a RESTful API for time tracking that enables integration with billing systems,...
Tokens:46,729
Snippets:187
Trust Score:9.9
Update:7 months ago
Show doc for...
Tokens:
Raw
### Get Project Information with Python Requests

Source: https://web.timingapp.com/docs/index.html

Provides a Python example using the 'requests' library to fetch project details. It defines the URL and headers, makes a GET request, and returns the JSON response.

```python
import requests
import json

url = 'https://web.timingapp.com/api/v1/projects/1'
headers = {
  'Authorization': 'Bearer {{token}}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()
```

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

### POST /api/time_entries/start

Source: https://web.timingapp.com/docs/index.html

Starts a new timer for a specific project or task.

```APIDOC
## POST /api/time_entries/start

### Description
Starts a new timer. This endpoint initiates tracking for a specific activity.

### Method
POST

### Endpoint
/api/time_entries/start

### Request Body
- **title** (string) - Required - The title of the timer
- **project_id** (integer) - Optional - The ID of the project to associate with the timer

### Request Example
{
  "title": "Development",
  "project_id": 123
}

### Response
#### Success Response (200)
- **id** (integer) - The ID of the created time entry

#### Response Example
{
  "id": 4567
}
```

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

### List Time Entries (Python Requests)

Source: https://web.timingapp.com/docs/index.html

An example of listing time entries using the Python Requests library. It defines the URL, parameters, and headers required to make an authenticated GET request.

```python
import requests
import json

url = 'https://web.timingapp.com/api/v1/time-entries'
params = {
  'start_date_min': '2019-01-01',
  'start_date_max': '2019-01-01',
  'projects[0]': '/projects/1',
  'include_child_projects': '1',
  'search_query': 'meeting',
  'is_running': '0',
  'include_project_data': '1',
  'include_team_members': '0',
  'team_members[0]': '/users/1',
  'billing_status[0]': 'billable',
}
headers = {
  'Authorization': 'Bearer {{token}}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()
```

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

### Start Timer API Request (cURL)

Source: https://web.timingapp.com/docs/index.html

This snippet demonstrates how to start a new timer using a cURL request to the TimingApp API. It includes the necessary headers for authentication and content type, along with a JSON payload containing timer details such as start date, project, title, notes, and custom fields. This method requires authentication.

```bash
curl --request POST \
    "https://web.timingapp.com/api/v1/time-entries/start" \
    --header "Authorization: Bearer {{token}}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"start_date\": \"2019-01-01T00:00:00+00:00\",
    \"project\": \"Unproductive child project\",
    \"title\": \"Client Meeting\",
    \"notes\": \"Some more detailed notes\",
    \"replace_existing\": false,
    \"custom_fields\": {
        \"field_name\": \"field_value\"
    },
    \"billing_status\": \"billable\" 
}"

```

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

### Retrieve Project List via GET

Source: https://web.timingapp.com/docs/collection.json

Fetches a list of all projects from the API. The request requires a GET method and returns a JSON array of project objects.

```HTTP
GET {{baseUrl}}/api/v1/projects?title=root&hide_archived=1&team_id=
Content-Type: application/json
Accept: application/json
```

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

### POST /api/v1/time-entries/start

Source: https://web.timingapp.com/docs/index.html

Starts a new timer. If a timer is currently running, this endpoint will stop it before starting the new one.

```APIDOC
## POST /api/v1/time-entries/start

### Description
Starts a new timer. This also stops the currently running timer if there is one.

### Method
POST

### Endpoint
https://web.timingapp.com/api/v1/time-entries/start

### Parameters
#### Request Body
- **start_date** (string) - Optional - ISO 8601 formatted start date.
- **project** (string) - Optional - Name of the project.
- **title** (string) - Optional - Title of the time entry.
- **notes** (string) - Optional - Detailed notes for the entry.
- **replace_existing** (boolean) - Optional - Whether to replace existing entries.
- **custom_fields** (object) - Optional - Key-value pairs for custom data.
- **billing_status** (string) - Optional - Billing status (e.g., "billable").

### Request Example
{
  "start_date": "2019-01-01T00:00:00+00:00",
  "project": "Unproductive child project",
  "title": "Client Meeting",
  "notes": "Some more detailed notes",
  "replace_existing": false,
  "custom_fields": {
      "field_name": "field_value"
  },
  "billing_status": "billable"
}

### Response
#### Success Response (201)
- **data** (object) - The created time entry object.
- **message** (string) - Confirmation message.

#### Response Example
{
  "data": {
      "self": "/time-entries/2",
      "start_date": "2019-01-01T00:00:00.000000+00:00",
      "end_date": "2019-01-01T00:00:00.000000+00:00",
      "duration": 0,
      "project": {
          "self": "/projects/2"
      },
      "title": "Client Meeting",
      "notes": "Some more detailed notes",
      "is_running": true,
      "creator_id": "/users/1",
      "creator_name": "Johnny Appleseed",
      "billing_status": "billable",
      "custom_fields": {
          "field_name": "field_value"
      }
  },
  "message": "Timer 'Client Meeting' started."
}
```

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

### Generate Report using JavaScript (Fetch API)

Source: https://web.timingapp.com/docs/index.html

Example of generating a report using the Fetch API in JavaScript. This code constructs the URL with query parameters and sets the necessary headers, including authorization. It then makes a GET request and processes the JSON response.

```javascript
const url = new URL(
    "https://web.timingapp.com/api/v1/report"
);

const params = {
    "include_app_usage": "0",
    "include_team_members": "0",
    "team_members[0]": "/users/1",
    "start_date_min": "2019-01-01",
    "start_date_max": "2019-01-01",
    "projects[0]": "/projects/1",
    "include_child_projects": "1",
    "search_query": "meeting",
    "billing_status[0]": "billable",
    "columns[0]": "project",
    "project_grouping_level": "0",
    "include_project_data": "1",
    "timespan_grouping_mode": "day",
    "sort[0]": "-duration",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {{token}}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
```

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

### Start Timer API Request (Python)

Source: https://web.timingapp.com/docs/index.html

This Python snippet demonstrates how to start a timer using the `requests` library to interact with the TimingApp API. It defines the API endpoint, the request payload as a dictionary, and the necessary headers. The `requests.request` method is used to send the POST request, and the response is then parsed as JSON.

```python
import requests
import json

url = 'https://web.timingapp.com/api/v1/time-entries/start'
payload = {
    "start_date": "2019-01-01T00:00:00+00:00",
    "project": "Unproductive child project",
    "title": "Client Meeting",
    "notes": "Some more detailed notes",
    "replace_existing": false,
    "custom_fields": {
        "field_name": "field_value"
    },
    "billing_status": "billable"
}
headers = {
  'Authorization': 'Bearer {{token}}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

```

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

### Show Running Timer - API Request Examples

Source: https://web.timingapp.com/docs/index.html

Demonstrates how to retrieve the currently running timer using the Web Timing App API. Requires authentication. This endpoint redirects to the specific time entry if one is running. Examples are provided for cURL, JavaScript (fetch), PHP (Guzzle), and Python (requests).

```curl
curl --request GET \
    --get "https://web.timingapp.com/api/v1/time-entries/running" \
    --header "Authorization: Bearer {{token}}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
```

```javascript
const url = new URL(
    "https://web.timingapp.com/api/v1/time-entries/running"
);

const headers = {
    "Authorization": "Bearer {{token}}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
```

```php
$client = new \GuzzleHttp\Client();
$url = 'https://web.timingapp.com/api/v1/time-entries/running';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {{token}}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
```

```python
import requests
import json

url = 'https://web.timingapp.com/api/v1/time-entries/running'
headers = {
  'Authorization': 'Bearer {{token}}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()
```

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

### Show Latest Time Entry - API Request Examples

Source: https://web.timingapp.com/docs/index.html

Demonstrates how to retrieve the latest time entry using the Web Timing App API. Requires authentication. This endpoint redirects to the specific time entry. Examples are provided for cURL, JavaScript (fetch), PHP (Guzzle), and Python (requests).

```curl
curl --request GET \
    --get "https://web.timingapp.com/api/v1/time-entries/latest" \
    --header "Authorization: Bearer {{token}}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
```

```javascript
const url = new URL(
    "https://web.timingapp.com/api/v1/time-entries/latest"
);

const headers = {
    "Authorization": "Bearer {{token}}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
```

```php
$client = new \GuzzleHttp\Client();
$url = 'https://web.timingapp.com/api/v1/time-entries/latest';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {{token}}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
```

```python
import requests
import json

url = 'https://web.timingapp.com/api/v1/time-entries/latest'
headers = {
  'Authorization': 'Bearer {{token}}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()
```

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

### Generate Report using Python (Requests)

Source: https://web.timingapp.com/docs/index.html

Example of generating a report using the Requests library in Python. This code defines the API endpoint, parameters for filtering and customization, and headers including the authorization token. It then sends a GET request and returns the JSON response.

```python
import requests
import json

url = 'https://web.timingapp.com/api/v1/report'
params = {
  'include_app_usage': '0',
  'include_team_members': '0',
  'team_members[0]': '/users/1',
  'start_date_min': '2019-01-01',
  'start_date_max': '2019-01-01',
  'projects[0]': '/projects/1',
  'include_child_projects': '1',
  'search_query': 'meeting',
  'billing_status[0]': 'billable',
  'columns[0]': 'project',
  'project_grouping_level': '0',
  'include_project_data': '1',
  'timespan_grouping_mode': 'day',
  'sort[0]': '-duration',
}
headers = {
  'Authorization': 'Bearer {{token}}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()
```

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

### Report Generation Response Example

Source: https://web.timingapp.com/docs/collection.json

This is an example of a successful JSON response from the report generation endpoint. It contains an array of data, where each object represents a report row with a 'duration' and 'project' field. The 'project' field itself is an object containing details about the project.

```JSON
{
    "data": [
        {
            "duration": 3600,
            "project": {
                "self": "\/projects\/1",
                "team_id": null,
                "title": "Project at root level",
                "title_chain": [
                    "Project at root level"
                ],
                "color": "#FF0000",
                "productivity_score": 1,
                "is_archived": false,
                "notes": null,
                "parent": null,
                "default_billing_status": "billable",
                "custom_fields": {}
            }
        }
    ]
}
```

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

### POST /api/v1/time-entries/start

Source: https://web.timingapp.com/docs/collection.json

Start a new timer for a project or task, automatically stopping any currently active timer.

```APIDOC
## POST /api/v1/time-entries/start

### Description
Start a new timer. This also stops the currently running timer if there is one. The title and project fields cannot both be empty.

### Method
POST

### Endpoint
/api/v1/time-entries/start

### Request Body
- **start_date** (string) - Required - ISO 8601 formatted date.
- **project** (string) - Optional - Name of the project.
- **title** (string) - Optional - Title of the time entry.
- **notes** (string) - Optional - Detailed notes.
- **replace_existing** (boolean) - Optional - Whether to replace existing entries.
- **billing_status** (string) - Optional - Billing status (e.g., billable).

### Request Example
{
  "start_date": "2019-01-01T00:00:00+00:00",
  "project": "Unproductive child project",
  "title": "Client Meeting",
  "notes": "Some more detailed notes",
  "replace_existing": false,
  "billing_status": "billable"
}

### Response
#### Success Response (201)
- **id** (string) - The ID of the created time entry.

#### Response Example
{
  "status": "created"
}
```

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

### Start Timer API Request (PHP)

Source: https://web.timingapp.com/docs/index.html

This PHP code utilizes the Guzzle HTTP client to send a POST request to the TimingApp API for starting a timer. It configures the request with necessary headers and a JSON payload containing timer details. The response body is then decoded from JSON for further processing.

```php
$client = new \GuzzleHttp\Client();
$url = 'https://web.timingapp.com/api/v1/time-entries/start';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {{token}}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'start_date' => '2019-01-01T00:00:00+00:00',
            'project' => 'Unproductive child project',
            'title' => 'Client Meeting',
            'notes' => 'Some more detailed notes',
            'replace_existing' => false,
            'custom_fields' => [
                'field_name' => 'field_value',
            ],
            'billing_status' => 'billable',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

```

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

### Create Project using JavaScript (Fetch API)

Source: https://web.timingapp.com/docs/index.html

Demonstrates how to create a new project using the Fetch API in JavaScript. This includes setting up the URL, headers, and JSON request body for the POST request.

```javascript
const url = new URL(
    "https://web.timingapp.com/api/v1/projects"
);

const headers = {
    "Authorization": "Bearer {{token}}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "Acme Inc.",
    "parent": "\/projects\/1",
    "color": "#FF0000",
    "productivity_score": 1,
    "is_archived": false,
    "notes": "Some more detailed notes",
    "default_billing_status": "billable",
    "custom_fields": {
        "field_name": "field_value"
    }
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

```

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

### Create Project using cURL

Source: https://web.timingapp.com/docs/index.html

Example of creating a new project using the cURL command-line tool. This demonstrates the HTTP POST request structure, headers, and JSON payload required for the API.

```bash
curl --request POST \
    "https://web.timingapp.com/api/v1/projects" \
    --header "Authorization: Bearer {{token}}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"Acme Inc.\",
    \"parent\": \"\\/projects\\/1\",
    \"color\": \"#FF0000\",
    \"productivity_score\": 1,
    \"is_archived\": false,
    \"notes\": \"Some more detailed notes\",
    \"default_billing_status\": \"billable\",
    \"custom_fields\": {
        \"field_name\": \"field_value\"
    }
}"

```

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

### GET /api/v1/time-entries/:time_entry_id

Source: https://web.timingapp.com/docs/collection.json

Retrieves a specific time entry by its ID. It includes details such as start and end dates, duration, project association, and billing status. An optional `other_user_id` query parameter can be used to specify the user whose time entries are being accessed.

```APIDOC
## GET /api/v1/time-entries/:time_entry_id

### Description
Display the specified time entry. The following attributes will be returned:

- `self`: A link to the entity itself, relative to the API root.
- `start_date`: The time entry's start date and time.
- `end_date`: The time entry's end date and time.
- `duration`: The time entry's total duration, in seconds.
- `project`: The project this time entry is associated with.
- `title`: The time entry's title.
- `notes`: The time entry's notes.
- `is_running`: Whether the time entry is currently running. Only one time entry can be running at any given time.
- `billing_status`: The billing status (undetermined, not_billable, billable, billed, paid).

### Method
GET

### Endpoint
/api/v1/time-entries/:time_entry_id

### Parameters
#### Path Parameters
- **time_entry_id** (integer) - Required - The ID of the time entry to display.

#### Query Parameters
- **other_user_id** (string) - Optional - The ID of the other user must be provided when making changes to the time entries of a colleague. This, along with the user having the required permissions, confirms that changes to the time entries of a colleague are allowed, and that the correct user is being targetted. Without this field, operations for other users will be rejected to prevent accidental changes to other users’ time entries.

### Response
#### Success Response (200)
- **self** (string) - A link to the entity itself.
- **start_date** (string) - The time entry's start date and time.
- **end_date** (string) - The time entry's end date and time.
- **duration** (integer) - The time entry's total duration, in seconds.
- **project** (object) - The project this time entry is associated with.
- **title** (string) - The time entry's title.
- **notes** (string) - The time entry's notes.
- **is_running** (boolean) - Whether the time entry is currently running.
- **creator_id** (string) - The ID of the user who created the time entry.
- **creator_name** (string) - The name of the user who created the time entry.
- **billing_status** (string) - The billing status.
- **custom_fields** (object) - Custom fields associated with the time entry.

#### Response Example
```json
{
  "data": {
    "self": "\/time-entries\/1",
    "start_date": "2019-01-01T00:00:00.000000+00:00",
    "end_date": "2019-01-01T01:00:00.000000+00:00",
    "duration": 3600,
    "project": {
      "self": "\/projects\/1"
    },
    "title": "Client Meeting",
    "notes": "Some more detailed notes",
    "is_running": false,
    "creator_id": "\/users\/1",
    "creator_name": "Johnny Appleseed",
    "billing_status": "billable",
    "custom_fields": {}
  }
}
```
```

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

### Create Project using Python (Requests)

Source: https://web.timingapp.com/docs/index.html

Shows how to create a new project using the Python Requests library. This example includes setting the URL, headers, and the JSON payload for the POST request.

```python
import requests
import json

url = 'https://web.timingapp.com/api/v1/projects'
payload = {
    "title": "Acme Inc.",
    "parent": "\/projects\/1",
    "color": "#FF0000",
    "productivity_score": 1,
    "is_archived": false,
    "notes": "Some more detailed notes",
    "default_billing_status": "billable",
    "custom_fields": {
        "field_name": "field_value"
    }
}
headers = {
  'Authorization': 'Bearer {{token}}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

```

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

### Create Project using PHP (Guzzle)

Source: https://web.timingapp.com/docs/index.html

Example of creating a new project using the Guzzle HTTP client in PHP. This shows how to configure the request with headers and a JSON body.

```php
$client = new \GuzzleHttp\Client();
$url = 'https://web.timingapp.com/api/v1/projects';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {{token}}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'title' => 'Acme Inc.',
            'parent' => '/projects/1',
            'color' => '#FF0000',
            'productivity_score' => 1.0,
            'is_archived' => false,
            'notes' => 'Some more detailed notes',
            'default_billing_status' => 'billable',
            'custom_fields' => [
                'field_name' => 'field_value',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

```

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

### Fetch Project Details using JavaScript

Source: https://web.timingapp.com/docs/index.html

Demonstrates how to fetch project details using the Fetch API in JavaScript. It constructs the URL, sets the required headers including authorization, and processes the JSON response.

```javascript
const url = new URL(
    "https://web.timingapp.com/api/v1/projects/1"
);

const headers = {
    "Authorization": "Bearer {{token}}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
```

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

### Sample Project Response (200 OK)

Source: https://web.timingapp.com/docs/index.html

An example of a successful response (HTTP 200) when retrieving project details. It includes the project's self-reference, team ID, title, color, productivity score, and other relevant attributes.

```json
{
    "data": {
        "self": "/projects/1",
        "team_id": null,
        "title": "Project at root level",
        "title_chain": [
            "Project at root level"
        ],
        "color": "#FF0000",
        "productivity_score": 1,
        "is_archived": false,
        "notes": null,
        "children": [
            {
                "self": "/projects/2"
            }
        ],
        "parent": null,
        "default_billing_status": "billable",
        "custom_fields": {}
    },
    "links": {
        "time-entries": "https://web.timingapp.com/api/v1/time-entries?project[]=/projects/1"
    }
}
```

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

### Start New Time Entry - API

Source: https://web.timingapp.com/docs/collection.json

Starts a new time entry, optionally stopping any currently running timer. Requires a start date and either a title or project. Supports custom fields and billing status. If billing status is omitted, it defaults based on project, team, or user settings.

```json
{
    "start_date": "2019-01-01T00:00:00+00:00",
    "project": "Unproductive child project",
    "title": "Client Meeting",
    "notes": "Some more detailed notes",
    "replace_existing": false,
    "custom_fields": {
        "field_name": "field_value"
    },
    "billing_status": "billable"
}
```

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

### Create New Project via POST

Source: https://web.timingapp.com/docs/collection.json

Creates a new project by sending a JSON body containing project details such as title, parent reference, and custom fields. Returns a 201 Created status upon success.

```HTTP
POST {{baseUrl}}/api/v1/projects
Content-Type: application/json
Accept: application/json

{
	"title": "Acme Inc.",
	"parent": "/projects/1",
	"color": "#FF0000",
	"productivity_score": 1,
	"is_archived": false,
	"notes": "Some more detailed notes",
	"default_billing_status": "billable",
	"custom_fields": {
		"field_name": "field_value"
	}
}
```

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

### GET /api/v1/time-entries/latest

Source: https://web.timingapp.com/docs/index.html

Retrieves a redirect to the latest time entry. This endpoint requires authentication and is only available for GET requests. It's useful for obtaining a link to the latest entry, which can then be used for further actions.

```APIDOC
## GET /api/v1/time-entries/latest

### Description
Retrieves a redirect to the latest time entry. This endpoint requires authentication and is only available for GET requests. It's useful for obtaining a link to the latest entry, which can then be used for further actions.

### Method
GET

### Endpoint
/api/v1/time-entries/latest

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (302 Redirect)
- **location** (string) - The URL to redirect to, pointing to the specific latest time entry.
- **content-type** (string) - The content type of the response, typically 'text/html; charset=utf-8'.

#### Response Example
```html
<!DOCTYPE html>
<html>
    <head>
        <meta charset="UTF-8" />
        <meta http-equiv="refresh" content="0;url='https://web.timingapp.com/api/v1/time-entries/1'" />

        <title>Redirecting to https://web.timingapp.com/api/v1/time-entries/1</title>
    </head>
    <body>
        Redirecting to <a href="https://web.timingapp.com/api/v1/time-entries/1">https://web.timingapp.com/api/v1/time-entries/1</a>.
    </body>
</html>
```
```

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

### Start Timer API Request (JavaScript)

Source: https://web.timingapp.com/docs/index.html

This JavaScript code snippet shows how to initiate a timer using the TimingApp API via the `fetch` API. It constructs the request URL, defines headers including authentication, and prepares the request body as a JSON object. The function returns a Promise that resolves with the JSON response from the server.

```javascript
const url = new URL(
    "https://web.timingapp.com/api/v1/time-entries/start"
);

const headers = {
    "Authorization": "Bearer {{token}}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "start_date": "2019-01-01T00:00:00+00:00",
    "project": "Unproductive child project",
    "title": "Client Meeting",
    "notes": "Some more detailed notes",
    "replace_existing": false,
    "custom_fields": {
        "field_name": "field_value"
    },
    "billing_status": "billable"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

```

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

### List Projects using cURL

Source: https://web.timingapp.com/docs/index.html

This snippet demonstrates how to list projects using a cURL command. It includes setting authentication headers, content type, and accept headers, along with query parameters for filtering projects by title and archive status.

```bash
curl --request GET \
    --get "https://web.timingapp.com/api/v1/projects?title=root&hide_archived=1" \
    --header "Authorization: Bearer {{token}}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
```

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

### GET /api/v1/teams

Source: https://web.timingapp.com/docs/collection.json

Retrieve a list of all teams the authenticated user is a member of.

```APIDOC
## GET /api/v1/teams

### Description
Return a list containing all the teams you are a member of.

### Method
GET

### Endpoint
/api/v1/teams

### Response
#### Success Response (200)
- **data** (array) - List of team objects containing id and name.

#### Response Example
{
  "data": [{"id": "/teams/1", "name": "Demo Team"}]
}
```

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

### List Projects using JavaScript (Fetch API)

Source: https://web.timingapp.com/docs/index.html

This JavaScript code snippet shows how to fetch a list of projects using the Fetch API. It constructs the URL with query parameters and sets the necessary authorization and content type headers. The response is then processed as JSON.

```javascript
const url = new URL(
    "https://web.timingapp.com/api/v1/projects"
);

const params = {
    "title": "root",
    "hide_archived": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {{token}}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
```

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

### GET /api/v1/projects

Source: https://web.timingapp.com/docs/index.html

Retrieves a flat list of projects with optional filtering capabilities.

```APIDOC
## GET /api/v1/projects

### Description
Returns a list of projects. Supports filtering by title and archival status.

### Method
GET

### Endpoint
/api/v1/projects

### Parameters
#### Query Parameters
- **title** (string) - Optional - Filter projects whose title contains the specified words.
- **hide_archived** (boolean) - Optional - If set to 1, excludes archived projects.
- **team_id** (string) - Optional - The ID of the team to list projects for.

### Response
#### Success Response (200)
- **data** (array) - List of project objects.

#### Response Example
{
	"data": [
		{
			"self": "/projects/1",
			"title": "Project at root level",
			"is_archived": false
		}
	]
}
```

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

### GET /api/v1/teams/:team_id/members

Source: https://web.timingapp.com/docs/collection.json

Retrieve a list of members belonging to a specific team.

```APIDOC
## GET /api/v1/teams/:team_id/members

### Description
List all members associated with the specified team ID.

### Method
GET

### Endpoint
/api/v1/teams/:team_id/members

### Parameters
#### Path Parameters
- **team_id** (string) - Required - The ID of the team to list members for.

### Response
#### Success Response (200)
- **members** (array) - List of team member objects.
```

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

### Retrieve Project Data with PHP Guzzle

Source: https://web.timingapp.com/docs/index.html

Shows how to retrieve project data using the Guzzle HTTP client in PHP. It sets up the client, defines the URL and headers, makes a GET request, and decodes the JSON response body.

```php
$client = new \GuzzleHttp\Client();
$url = 'https://web.timingapp.com/api/v1/projects/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {{token}}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
```

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

### GET /api/v1/projects

Source: https://web.timingapp.com/docs/collection.json

Lists projects with optional filtering by title and archive status.

```APIDOC
## GET /api/v1/projects

### Description
Retrieve a list of projects. Supports filtering by title and excluding archived projects.

### Method
GET

### Endpoint
/api/v1/projects

### Parameters
#### Query Parameters
- **title** (string) - Optional - Filter for projects whose title contains these words.
- **hide_archived** (integer) - Optional - Set to 1 to exclude archived projects and their children.
- **team_id** (string) - Optional - The ID of the team to list projects for.

### Request Example
GET /api/v1/projects?title=root&hide_archived=1

### Response
#### Success Response (200)
- **data** (array) - A list of project objects matching the filter criteria.

#### Response Example
{
  "data": [
    {
      "self": "/projects/1",
      "title": "Project at root level"
    }
  ]
}
```

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

### GET /api/v1/projects/hierarchy

Source: https://web.timingapp.com/docs/collection.json

Retrieves the complete project hierarchy for the user or a specified team.

```APIDOC
## GET /api/v1/projects/hierarchy

### Description
Return the complete project hierarchy. This endpoint provides a nested view of all projects and their children.

### Method
GET

### Endpoint
/api/v1/projects/hierarchy

### Parameters
#### Query Parameters
- **team_id** (string) - Optional - The ID of the team to list projects for. Omit to list user's private projects.

### Request Example
GET /api/v1/projects/hierarchy

### Response
#### Success Response (200)
- **data** (array) - A list of root-level projects containing nested children.

#### Response Example
{
  "data": [
    {
      "self": "/projects/1",
      "title": "Project at root level",
      "children": [
        {
          "self": "/projects/2",
          "title": "Unproductive child project"
        }
      ]
    }
  ]
}
```

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

### List Time Entries (JavaScript Fetch API)

Source: https://web.timingapp.com/docs/index.html

Demonstrates how to fetch a list of time entries using the JavaScript Fetch API. It constructs the URL with query parameters and sets necessary headers for authentication and content type.

```javascript
const url = new URL(
    "https://web.timingapp.com/api/v1/time-entries"
);

const params = {
    "start_date_min": "2019-01-01",
    "start_date_max": "2019-01-01",
    "projects[0]": "/projects/1",
    "include_child_projects": "1",
    "search_query": "meeting",
    "is_running": "0",
    "include_project_data": "1",
    "include_team_members": "0",
    "team_members[0]": "/users/1",
    "billing_status[0]": "billable",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {{token}}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
```

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

### GET /api/v1/projects/{project_id}

Source: https://web.timingapp.com/docs/index.html

Retrieves the details of a specific project by its ID. Requires authentication.

```APIDOC
## GET /api/v1/projects/{project_id}

### Description
Retrieves the details of a specific project by its ID. Requires authentication.

### Method
GET

### Endpoint
`/api/v1/projects/{project_id}`

### Parameters
#### Path Parameters
- **project_id** (string) - Required - The unique identifier of the project to retrieve.

#### Query Parameters
None

#### Request Body
None

### Request Example
```
curl --request GET \
    --get "https://web.timingapp.com/api/v1/projects/1" \
    --header "Authorization: Bearer {{token}}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
```

### Response
#### Success Response (200)
- **self** (string) - A reference to the entity itself, relative to the API root.
- **title** (string) - The project's title.
- **title_chain** (array) - An array containing the title of the project and all its ancestors.
- **color** (string) - The project's color, in hexadecimal format (`#RRGGBB`).
- **productivity_score** (number) - The project's productivity rating, between -1 and 1.
- **is_archived** (boolean) - Whether the project has been archived.
- **parent** (string) - A reference to the enclosing project.
- **children** (array) - The project's children (each child object contains a 'self' attribute).
- **team_id** (string) - The ID of the team that this project belongs to, if applicable.
- **default_billing_status** (string) - The project's default billing status for new time entries (not_billable, billable, or null for inherited).
- **custom_fields** (object) - A list of custom field name/value pairs.

#### Response Example
```json
{
    "data": {
        "self": "/projects/1",
        "team_id": null,
        "title": "Project at root level",
        "title_chain": [
            "Project at root level"
        ],
        "color": "#FF0000",
        "productivity_score": 1,
        "is_archived": false,
        "notes": null,
        "children": [
            {
                "self": "/projects/2"
            }
        ],
        "parent": null,
        "default_billing_status": "billable",
        "custom_fields": {}
    },
    "links": {
        "time-entries": "https://web.timingapp.com/api/v1/time-entries?project[]=/projects/1"
    }
}
```
```

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

### List Time Entries (cURL)

Source: https://web.timingapp.com/docs/index.html

Example of how to list time entries using cURL. This request includes various parameters for filtering and authentication. It requires a bearer token for authorization.

```bash
curl --request GET \
    --get "https://web.timingapp.com/api/v1/time-entries?start_date_min=2019-01-01&start_date_max=2019-01-01&projects[]=%2Fprojects%2F1&include_child_projects=1&search_query=meeting&is_running=0&include_project_data=1&include_team_members=0&team_members[]=%2Fusers%2F1&billing_status[]=billable" \
    --header "Authorization: Bearer {{token}}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
```

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

### GET /api/time_entries

Source: https://web.timingapp.com/docs/index.html

Retrieves a list of time entries with optional project data inclusion.

```APIDOC
## GET /api/time_entries

### Description
List all time entries. Use query parameters to filter or include additional data.

### Method
GET

### Endpoint
/api/time_entries

### Parameters
#### Query Parameters
- **include_project_data** (boolean) - Optional - If true, includes project attributes in the response

### Response
#### Success Response (200)
- **data** (array) - List of time entry objects

#### Response Example
{
  "data": [
    {
      "id": 1,
      "title": "Work",
      "project": { "id": 123, "name": "Project A" }
    }
  ]
}
```

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

### Create Project API

Source: https://web.timingapp.com/docs/index.html

This endpoint allows for the creation of a new project within the Web Timing App. It requires authentication and accepts project details in the request body.

```APIDOC
## POST /api/v1/projects

### Description
Create a new project. See Display the specified project. for the returned attributes.

### Method
POST

### Endpoint
/api/v1/projects

### Parameters
#### Headers
- **Authorization** (string) - Required - Bearer token for authentication. Example: `Bearer {{token}}`
- **Content-Type** (string) - Required - Specifies the request body format. Example: `application/json`
- **Accept** (string) - Required - Specifies the desired response format. Example: `application/json`

#### Request Body
- **title** (string) - Required - The name of the project.
- **parent** (string) - Optional - The identifier of the parent project, if any. Example: `/projects/1`
- **color** (string) - Optional - A hex color code for the project. Example: `#FF0000`
- **productivity_score** (integer) - Optional - A score indicating project productivity.
- **is_archived** (boolean) - Optional - Indicates if the project is archived.
- **notes** (string) - Optional - Detailed notes about the project.
- **default_billing_status** (string) - Optional - The default billing status for the project (e.g., `billable`).
- **custom_fields** (object) - Optional - A key-value object for custom project fields.

### Request Example
```json
{
    "title": "Acme Inc.",
    "parent": "\/projects\/1",
    "color": "#FF0000",
    "productivity_score": 1,
    "is_archived": false,
    "notes": "Some more detailed notes",
    "default_billing_status": "billable",
    "custom_fields": {
        "field_name": "field_value"
    }
}
```

### Response
#### Success Response (201)
- **data** (object) - Contains the details of the created project.
  - **self** (string) - The API endpoint for the created project.
  - **team_id** (string|null) - The ID of the team associated with the project.
  - **title** (string) - The name of the project.
  - **title_chain** (array) - A hierarchical list of project titles leading to this project.
  - **color** (string) - The hex color code of the project.
  - **productivity_score** (integer) - The productivity score of the project.
  - **is_archived** (boolean) - Indicates if the project is archived.
  - **notes** (string) - Notes about the project.
  - **children** (array) - A list of child projects.
  - **parent** (object) - Information about the parent project.
    - **self** (string) - The API endpoint for the parent project.
  - **default_billing_status** (string) - The default billing status.
  - **custom_fields** (object) - Custom fields associated with the project.
- **links** (object) - Links related to the project.
  - **time-entries** (string) - Link to retrieve time entries for this project.

#### Response Example
```json
{
    "data": {
        "self": "/projects/2",
        "team_id": null,
        "title": "Acme Inc.",
        "title_chain": [
            "Project at root level",
            "Acme Inc."
        ],
        "color": "#FF0000",
        "productivity_score": 1,
        "is_archived": false,
        "notes": "Some more detailed notes",
        "children": [],
        "parent": {
            "self": "/projects/1"
        },
        "default_billing_status": "billable",
        "custom_fields": {
            "field_name": "field_value"
        }
    },
    "links": {
        "time-entries": "https://web.timingapp.com/api/v1/time-entries?project[]=/projects/2"
    }
}
```
```
Tokens:
Raw