Freelo API v1

https://freelo.docs.apiary.io
Admin
The Freelo API v1 provides programmatic access to Freelo's project management features, including...
Tokens:2,395,038
Snippets:9,963
Trust Score:9.9
Update:11 months ago
Show doc for...
Tokens:
Raw
### Get Project Response Example - JSON

Source: https://freelo.docs.apiary.io/reference/projects/project/get-project

Example JSON response for GET request to https://api.freelo.io/v1/project/project_id endpoint. Shows complete project data structure including nested task lists, worker details, budget, and time tracking. Demonstrates 200 OK response format with comprehensive project metadata for API integration.

```json
{
    "id": 1,
    "name": "Project name",
    "date_add": "2021-10-03T15:00:00+02:00",
    "date_edited_at": "2021-10-04T09:32:00+02:00",
    "state": {
        "id": 1,
        "state": "active",
    },
    "tasklists": [
        {
            "id": 1,
            "name": "tasklist name",
            "tasks": [
                {
                    "id": 2,
                    "name": "task name",
                    "due_date": "2020-04-23 00:00:00",
                    "due_date_end": "2020-04-24 00:00:00",
                    "worker": {
                        "id": 1,
                        "fullname": "John Newman"
                    },
                    "parent_task_id": 1
                }
            ]
        }
    ],
    "minutes_budget": 3000,
    "budget": {
        "amount": 50000,
        "currency": "CZK"
    },
    "real_minutes_spent": 45,
    "real_cost": {
        "amount": 20000,
        "currency": "CZK"
    },
    "workers": [
        {
            "id": 3,
            "fullname": "Worker Name",
            "hour_rate": {
                "amount": 100000,
                "currency": "CZK",
                "is_fixed": false
            }
        },
                            {
            "id": 4,
            "fullname": "John Doe",
            "hour_rate": null
        }
    ]
}
```

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

### GET /projects

Source: https://freelo.docs.apiary.io/introduction/authentication

Returns a paginated list of projects. Use Basic Authentication with your email and API key. Paginate with the p query parameter starting at 0.

```APIDOC
## GET /projects

### Description
Returns a paginated list of projects for the authenticated user. Use the p query parameter to control pagination.

### Method
GET

### Endpoint
https://api.freelo.io/v1/projects

### Parameters
#### Path Parameters
- None

#### Query Parameters
- **p** (integer) - Optional - Page index starting from 0 (default 0)

#### Request Body
- None

### Request Example
curl -u your@email.tld:API_KEY -H 'User-Agent: Your_App_Id (email@company.tld)' \
    https://api.freelo.io/v1/projects

### Response
#### Success Response (200)
- **total** (integer) - Total number of items across all pages
- **count** (integer) - Number of items returned in this page
- **page** (integer) - Current page index
- **per_page** (integer) - Maximum items per page
- **data** (object) - Collection of project objects

#### Response Example
{
  "total": 125,
  "count": 25,
  "page": 0,
  "per_page": 100,
  "data": {
    "projects": [
      {
        "id": 123,
        "name": "Website Redesign",
        "created_at": "2020-01-01T12:00:00Z",
        "updated_at": "2020-01-10T12:00:00Z"
      }
    ]
  }
}

```

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

### Paginated response example

Source: https://freelo.docs.apiary.io/introduction/response-format

Example of a paginated API response showing total items, current page count, and data. Pages are accessed via the 'p' GET parameter starting from 0.

```json
{
    "total": 125,
    "count": 25,
    "page": 1,
    "per_page": 100,
    "data": {…}
}
```

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

### Request Format and Example

Source: https://freelo.docs.apiary.io/reference/comments/create-api

Details the base URL for all API requests and provides an example of how to fetch a list of projects, including required headers.

```APIDOC
## Request Format
All requests point to URL that begins with `https://api.freelo.io/v1/`.
Each request must include a User-Agent HTTP header.

### Example: projects list
```curl
curl -u your@email.tld:API_KEY -H 'User-Agent: Your_App_Id (email@company.tld)' \
    https://api.freelo.io/v1/projects
```

`Your_App_Id` is not any defined value. Please enter what best describes the purpose of using the API. If you do not know what to enter, then your name will suffice.
```

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

### API Introduction

Source: https://freelo.docs.apiary.io/reference/users/manage-users/invite-users-to-the-projects-by-emails

Provides general information on how to use the Freelo API, including base URL, request and response formats, authentication, error handling, rate limiting, currencies, and pagination.

```APIDOC
### Introduction
API documentation for Freelo.io.

### Request Format
All requests point to URLs beginning with `https://api.freelo.io/v1/`. Each request must include a User-Agent HTTP header. Example for projects list:
```
curl -u your@email.tld:API_KEY -H 'User-Agent: Your_App_Id (email@company.tld)' \
    https://api.freelo.io/v1/projects
```
Your_App_Id describes the purpose of using the API.

### Response Format
The API supports only JSON in UTF-8 encoding.

### Authentication
Use HTTP Basic Authentication with email as username and API key as password. Find API key in settings.

### HTTP Status Codes
- 200: Success
- 4xx: Client errors (e.g., no source found or action rejected)
- 5xx: Server errors

### Rate Limiting
Up to 25 requests per minute. Exceeding returns 429 Too Many Requests; wait 60 seconds.

### Currencies Format
Amounts as strings with 2 decimal places multiplied by 100 (e.g., "100025" for 1,000.25). Supported: CZK, EUR, USD. Response: {"amount": "100", "currency": "USD"}

### Paginated Response Format
Use `p` query parameter starting from 0. Example: `/api/v1/archived-projects?p=1`
Response:
{
    "total": 125,
    "count": 25,
    "page": 1,
    "per_page": 100,
    "data": {…}
}
```

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

### Paginated response example

Source: https://freelo.docs.apiary.io/reference/projects/remove-project-workers/create-api

Illustrates how pagination works in the Freelo API. Pages are set via GET parameter 'p' starting from 0. The response includes total count, current page, items per page, and the data payload.

```javascript
// Example request:
// /api/v1/archived-projects?p=1

// Response:
{
    "total": 125,
    "count": 25,
    "page": 1,
    "per_page": 100,
    "data": {…}
}
```

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

### Paginated API response example

Source: https://freelo.docs.apiary.io/reference/tasks/move-task

Illustrates the paginated response format used by the API. Pages are set via GET parameter 'p' starting from 0. Response includes total count, current page, items per page, and data.

```javascript
// Example request URL:
// /api/v1/archived-projects?p=1

// Response format:
{
    "total": 125,
    "count": 25,
    "page": 1,
    "per_page": 100,
    "data": {…}
}
```

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

### Projects List Example

Source: https://freelo.docs.apiary.io/reference/time-tracking/start-time-tracking/start-time-tracking

This example demonstrates how to retrieve a list of projects using the Freelo API v1. It includes the necessary cURL command with authentication and User-Agent header.

```APIDOC
## GET /v1/projects

### Description
Retrieves a list of all projects.

### Method
GET

### Endpoint
`https://api.freelo.io/v1/projects`

### Parameters
#### Query Parameters
- **p** (integer) - Optional - The page number for paginated results, starting from 0.

### Request Example
```bash
curl -u your@email.tld:API_KEY -H 'User-Agent: Your_App_Id (email@company.tld)' \
    https://api.freelo.io/v1/projects
```

**Note:** Replace `your@email.tld` with your Freelo email, `API_KEY` with your actual API key, and `Your_App_Id` with a descriptive identifier for your application.

### Response
#### Success Response (200)
- **total** (integer) - The total number of projects available.
- **count** (integer) - The number of projects returned in the current response.
- **page** (integer) - The current page number.
- **per_page** (integer) - The number of projects per page.
- **data** (object) - An object containing the project details.

#### Response Example
```json
{
    "total": 125,
    "count": 25,
    "page": 0,
    "per_page": 100,
    "data": { ... }
}
```
```

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

### Start Time Tracking

Source: https://freelo.docs.apiary.io/reference/invoicing/issued-invoice-detail/get-issued-invoice-detail

Starts the time tracking for a specific task.

```APIDOC
## POST /v1/track-time

### Description
Starts the time tracking for a given task. If time tracking is already in progress for this task, this action might return an error or update the existing entry depending on the API's implementation.

### Method
POST

### Endpoint
/v1/track-time

#### Request Body
- **task_id** (integer) - Required - The ID of the task for which to start time tracking.

### Request Example
```json
{
  "task_id": 456
}
```

### Response
#### Success Response (200)
- **id** (integer) - The ID of the new time tracking entry.
- **task_id** (integer) - The ID of the task associated with this time tracking.
- **started_at** (string) - The timestamp when time tracking started (ISO 8601 format).

#### Response Example
```json
{
    "id": 789,
    "task_id": 456,
    "started_at": "2023-10-27T10:30:00Z"
}
```
```

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

### API Introduction and General Info

Source: https://freelo.docs.apiary.io/reference/projects/activate-project/activate-project

Provides an overview of the Freelo API v1, including request format, response format, authentication, HTTP status codes, rate limiting, currencies, paginated responses, and ordering.

```APIDOC
## Introduction

### Request format
All request point to URL that begins with `https://api.freelo.io/v1/`.
Each request must include a User-Agent HTTP header.

### Example: projects list
```
curl -u your@email.tld:API_KEY -H 'User-Agent: Your_App_Id (email@company.tld)' \
    https://api.freelo.io/v1/projects
```

Your_App_Id is not any defined value. Please enter what best describes the purpose of using the API. If you do not know what to enter, then your name will suffice.

### Response format
The API only supports JSON format in UTF-8 encoding.

### Authentication
Authentication is done using HTTP Basic Authentication. As your username, type your email to log in to Freelo, and use the API key as a password. You can find API key in settings.

### HTTP status codes - handling errors
Check response HTTP status code to check if everything was ok.
If there is an error on our side, reponse code will be `5xx`. If no source is found or the action is rejected for another reason, the code will be `4xx`.
If everything is ok, the code will be '200'.

#### Rate limiting (429 Too Many Requests)
You can perform up to 25 requests per minute. If you exceed this limit 429 Too Many Requests HTTP status code will be returned. You have to wait at least 60 seconds before you send another request.

### Currencies format
All currencies amount must be strings with exactly 2 decimal places multiplied by 100.
Only these currencies iso codes are supported:
  * CZK
  * EUR
  * USD

Example for en_us:
```
1,000.25 = "100025"
1,000 = "100000"
```

Example for cs_cz:
```
1 000,25 = "100025"
1 000 = "100000"
1 = "100"
```

Result currency object will be always with 2 keys - amount and currency iso code:
```
{
    "amount": "100",
    "currency": "USD"
}
```

### Paginated response format
Pages are set via GET parameter `p` starting from 0 (p=0 is default and always first page).
Example:
```
/api/v1/archived-projects?p=1
```

Response is:
```
{
    "total": 125,
    "count": 25,
    "page": 1,
    "per_page": 100,
    "data": {…}
}
```

### Order response data

### Testing

### Create task with special URL
  * URL parameters 
  * Examples 

### Reference
* Projects 
  * Projects collection 
  * All projects collection 
  * Invited projects collection 
  * Archived projects collection 
  * Template projects collection 
  * Users projects collection 
  * Project workers collection 
  * Archive project 
  * Activate project 
  * Project 
  * Remove project workers 
  * Project from template 


* Project labels 
  * Project labels collection 
  * Project label 
  * Add project label to project 
  * Remove project label from project 


* Pinned items 
  * Pinned items collection 
  * Pined item 


* Tasklists 
  * Tasklists collection 
  * All tasklists collection 
  * Assignable workers collection 
  * Tasklist 
  * Tasklist from template 


* Tasks 
  * Tasks collection 
  * All tasks collection 
  * Finished tasks collection 
  * Activate task 
  * Finish task 
  * Move task 
  * Task 
  * Task description 
  * Task reminder 
  * Public links 
  * Task from template 
  * Time estimates total 
  * Time estimates user 


* Subtasks 
  * Subtasks in task 


* Task labels 
  * Task labels collection 


* Comments 
  * Comments collection 
  * All comments collection 


* Time tracking 
  * Start time tracking 
  * Stop time tracking 
  * Edit time tracking 


* Work reports 
  * Work reports 
  * Task work reports 


* Invoicing 
  * Issued invoices 
  * Issued invoice detail 
  * Issued invoice reports 
  * Mark as invoiced 


* Users 
  * Find all users - coworkers 
  * Find users who promoted me as project manager 
  * Manage users 
  * Out of office 


* Notifications 
  * Find all notifications 
  * Mark as read 
  * Mark as unread 


* Events 
  * Find all events 


* Files 
  * Download file 
  * Upload file 
  * Items collection 


* States 
  * Find all states 


* Custom fields 
  * Custom fields types 
  * Custom fields 
  * Values 
  * Enums 
  * On project 


* Notes 
  * Create note 
  * Note 


* Search 
  * Elasticsearch 


  * Reference
  * Projects
  * Activate project
```

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

### Get Tasklist by ID using Node.js

Source: https://freelo.docs.apiary.io/reference/tasklists/tasklist/get-tasklist

Shows how to get a tasklist by its ID using Node.js. This example can be integrated into server-side applications.

```javascript
/* Node.js code for getting tasklist */
// This is a placeholder. Actual Node.js code would typically use 'node-fetch' or 'axios'.
```

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

### API Introduction and Request Format

Source: https://freelo.docs.apiary.io/reference/time-tracking/start-time-tracking/create-api

Details on the base URL, required headers, and general request format for the Freelo API v1.

```APIDOC
## Introduction
All API requests point to the base URL `https://api.freelo.io/v1/`.

### Request Format
Each request must include a `User-Agent` HTTP header. The value should describe the application using the API, e.g., `Your_App_Id (email@company.tld)`.

### Example: Projects List
```bash
curl -u your@email.tld:API_KEY -H 'User-Agent: Your_App_Id (email@company.tld)' \
    https://api.freelo.io/v1/projects
```

## Response Format
The API only supports JSON format in UTF-8 encoding.
```

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

### Edit Time Tracking

Source: https://freelo.docs.apiary.io/reference/invoicing/issued-invoice-detail/get-issued-invoice-detail

Allows editing of an existing time tracking entry, for example, to correct the start or end time.

```APIDOC
## PUT /v1/track-time/{id}

### Description
Edits an existing time tracking entry. You can modify the start time, stop time, or associated task.

### Method
PUT

### Endpoint
/v1/track-time/{id}

#### Path Parameters
- **id** (integer) - Required - The ID of the time tracking entry to edit.

#### Request Body
- **task_id** (integer) - Optional - The new task ID to associate with this time entry.
- **started_at** (string) - Optional - The new start time in ISO 8601 format.
- **stopped_at** (string) - Optional - The new stop time in ISO 8601 format.

### Request Example
```json
{
  "started_at": "2023-10-27T10:00:00Z",
  "stopped_at": "2023-10-27T12:00:00Z"
}
```

### Response
#### Success Response (200)
- **id** (integer) - The ID of the edited time tracking entry.
- **task_id** (integer) - The ID of the associated task.
- **started_at** (string) - The updated start time.
- **stopped_at** (string) - The updated stop time.
- **duration** (integer) - The updated duration in seconds.

#### Response Example
```json
{
    "id": 789,
    "task_id": 456,
    "started_at": "2023-10-27T10:00:00Z",
    "stopped_at": "2023-10-27T12:00:00Z",
    "duration": 7200
}
```
```

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

### Projects List Example

Source: https://freelo.docs.apiary.io/reference/time-tracking/create-api

Example of how to retrieve a list of projects using the Freelo API v1.

```APIDOC
## GET /v1/projects

### Description
Retrieves a list of all projects.

### Method
GET

### Endpoint
`https://api.freelo.io/v1/projects`

### Parameters
#### Query Parameters
- **p** (integer) - Optional - The page number for paginated results, defaults to 0.

### Request Headers
- **User-Agent** (string) - Required - Identifies your application.
- **Authorization** (string) - Required - Basic Auth with email and API key.

### Request Example
```bash
curl -u your@email.tld:API_KEY -H 'User-Agent: Your_App_Id (email@company.tld)' \
    https://api.freelo.io/v1/projects
```

### Response
#### Success Response (200)
- **total** (integer) - The total number of projects available.
- **count** (integer) - The number of projects returned in this response.
- **page** (integer) - The current page number.
- **per_page** (integer) - The number of projects per page.
- **data** (object) - An object containing the project data.

#### Response Example
```json
{
    "total": 125,
    "count": 25,
    "page": 0,
    "per_page": 25,
    "data": { ... }
}
```
```

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

### POST Create Project from Template

Source: https://freelo.docs.apiary.io/reference/files

Create a new project based on an existing template, allowing quick project setup with predefined structure and settings.

```APIDOC
## POST /api/v1/projects/from-template

### Description
Create new project from an existing template with predefined structure and settings

### Method
POST

### Endpoint
/api/v1/projects/from-template

### Parameters
#### Request Body
- **template_id** (integer) - Required - ID of the template to use
- **name** (string) - Required - Name for the new project
- **description** (string) - Optional - Project description

### Request Example
{
  "template_id": 123,
  "name": "New Project from Template",
  "description": "Project created from template"
}

### Response
#### Success Response (201)
- **id** (integer) - Created project ID
- **name** (string) - Project name
- **status** (string) - Project status
```

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

### Get Task Description Response Example in JSON

Source: https://freelo.docs.apiary.io/reference/tasks/task-description/get-task-description

This JSON example illustrates the response structure for the GET /v1/task/{task_id}/description endpoint. It includes task description details such as ID, content, creation date, and attached files. No dependencies or inputs are shown beyond the required task_id parameter; the output is a JSON object with potential file attachments.

```json
{
  "id": 1677,
  "content": "<p>Description content...</p>",
  "date_add": "2016-08-30T18:35:53+0200",
  "files": [
    {
      "id": 1135,
      "filename": "max_1352239.jpg",
      "size": 93461
    }
  ]
}
```

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

### Base setup and global conventions

Source: https://freelo.docs.apiary.io/reference/users/find-all-users-coworkers/paginated-collection-of-all-users

Base URL, authentication, rate limits, pagination, and currency conventions used across the Freelo API.

```APIDOC
## Base setup

Base URL: `https://api.freelo.io/v1/`

### Authentication
- HTTP Basic Authentication
- Username: your Freelo email
- Password: your API key (found in settings)
- Example header:
  - `Authorization: Basic base64(email:API_KEY)`

### Rate limiting
- Limit: 25 requests per minute
- If exceeded: HTTP `429 Too Many Requests`
- Wait at least 60 seconds before retrying

### Pagination
- Pages are set via GET parameter `p` starting from 0 (p=0 is the first page)
- Example request:
  ```
  GET https://api.freelo.io/v1/archived-projects?p=1
  ```
- Response format:
  ```json
  {
    "total": 125,
    "count": 25,
    "page": 1,
    "per_page": 100,
    "data": { … }
  }
  ```

### Currencies
- All currency amounts are strings with exactly two decimal places multiplied by 100
- Supported ISO codes: `CZK`, `EUR`, `USD`

en_US examples:
- `1,000.25` → `"100025"`
- `1,000`    → `"100000"`

cs_CZ examples:
- `1 000,25` → `"100025"`
- `1 000`    → `"100000"`
- `1`        → `"100"`

Returned currency object always has two keys:
```json
{
  "amount": "100",
  "currency": "USD"
}
```

### Known collections (paths not present in this text)
- Projects
- Project labels
- Pinned items
- Tasklists
- Tasks
- Subtasks
- Task labels
- Comments
- Time tracking
- Work reports
- Invoicing
- Users
- Notifications
- Events
- Files
- States
- Custom fields
- Notes
- Search
```

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

### GET /api/tasks/:id/time_tracking/start

Source: https://freelo.docs.apiary.io/reference/invoicing/mark-as-invoiced/mark-issued-invoice-as-invoiced

Start time tracking for a specific task to begin monitoring work duration.

```APIDOC
## GET /api/tasks/:id/time_tracking/start

### Description
Start time tracking for a specific task to begin monitoring work duration.

### Method
GET

### Endpoint
/api/tasks/:id/time_tracking/start

### Parameters
#### Path Parameters
- **id** (integer) - Required - ID of the task

#### Query Parameters
None

#### Request Body
None

### Request Example
GET /api/tasks/321/time_tracking/start

### Response
#### Success Response (200)
- **task_id** (integer) - Task ID
- **started_at** (datetime) - Start timestamp
- **tracker_id** (integer) - Time tracking session ID
- **status** (string) - Tracking status (started)

#### Response Example
{
  "task_id": 321,
  "started_at": "2024-01-15T14:00:00Z",
  "tracker_id": 777,
  "status": "started"
}
```

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

### Projects List Example

Source: https://freelo.docs.apiary.io/introduction/request-format/example%3A-projects-list

An example demonstrating how to retrieve a list of projects using `curl` and HTTP Basic Authentication.

```APIDOC
## Example: projects list

### Description
This example shows how to retrieve the list of projects using `curl` and HTTP Basic Authentication.

### Request Example
```
curl -u your@email.tld:API_KEY -H 'User-Agent: Your_App_Id (email@company.tld)' \
    https://api.freelo.io/v1/projects

```

Your_App_Id is not any defined value. Please enter what best describes the purpose of using the API. If you do not know what to enter, then your name will suffice.
```

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

### Get Issued Invoices - Swift Example

Source: https://freelo.docs.apiary.io/reference/invoicing/issued-invoices/issued-invoices-collection

Retrieves a list of issued invoices within a specified date range and for given project IDs. This Swift example demonstrates how to make the API call.

```swift
// Swift example for fetching issued invoices would go here.
// Uses URLSession.
```

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

### Projects List Example

Source: https://freelo.docs.apiary.io/reference/task-labels/task-labels-collection/create-task-labels

An example of how to retrieve a list of projects using the Freelo API v1. This demonstrates the request format, including authentication and the User-Agent header.

```APIDOC
## GET /v1/projects

### Description
Retrieves a list of all projects accessible to the authenticated user.

### Method
GET

### Endpoint
`https://api.freelo.io/v1/projects`

### Parameters
#### Query Parameters
- **p** (integer) - Optional - The page number for paginated results, starting from 0.

#### Request Body
None

### Request Example
```bash
curl -u your@email.tld:API_KEY -H 'User-Agent: Your_App_Id (email@company.tld)' \
    https://api.freelo.io/v1/projects
```

Your_App_Id should be a string that best describes the purpose of using the API.

### Response
#### Success Response (200)
- **total** (integer) - The total number of projects available.
- **count** (integer) - The number of projects returned in the current response.
- **page** (integer) - The current page number.
- **per_page** (integer) - The number of projects per page.
- **data** (object) - An object containing the project details.

#### Response Example
```json
{
    "total": 125,
    "count": 25,
    "page": 0,
    "per_page": 100,
    "data": {
        // Project objects will be listed here
    }
}
```
```

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

### Projects List Example

Source: https://freelo.docs.apiary.io/reference/custom-fields

An example of listing projects using the Freelo API.  It demonstrates the use of HTTP Basic Authentication and the User-Agent header.

```APIDOC
## Projects List

### Description
This endpoint demonstrates how to list projects using the Freelo API.

### Method
GET

### Endpoint
https://api.freelo.io/v1/projects

### Parameters
#### Query Parameters
- **p** (integer) - Optional - Page number. Starts from 0 (default is 0).

### Request Example
```
curl -u your@email.tld:API_KEY -H 'User-Agent: Your_App_Id (email@company.tld)' \
    https://api.freelo.io/v1/projects
```

### Response
#### Success Response (200)
- **total** (integer) - The total number of projects.
- **count** (integer) - The number of projects on the current page.
- **page** (integer) - The current page number.
- **per_page** (integer) - The number of projects per page.
- **data** (array) - An array of project objects.

#### Response Example
```json
{
    "total": 125,
    "count": 25,
    "page": 1,
    "per_page": 100,
    "data": {…}
}
```
```

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

### Get Issued Invoices - Objective-C Example

Source: https://freelo.docs.apiary.io/reference/invoicing/issued-invoices/issued-invoices-collection

Retrieves a list of issued invoices within a specified date range and for given project IDs. This Objective-C example demonstrates how to make the API call.

```objectivec
// Objective-C example for fetching issued invoices would go here.
// Uses NSURLSession.
```

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

### Get Issued Invoices - Groovy Example

Source: https://freelo.docs.apiary.io/reference/invoicing/issued-invoices/issued-invoices-collection

Retrieves a list of issued invoices within a specified date range and for given project IDs. This Groovy example demonstrates how to make the API call.

```groovy
// Groovy example for fetching issued invoices would go here.
// Can use Groovy's HTTPBuilder or standard Java libraries.
```

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

### Projects List Example

Source: https://freelo.docs.apiary.io/reference/task-labels/task-labels-collection/create-api

Example request to retrieve the list of projects using `curl` and HTTP Basic Authentication. Replace placeholders with your actual email and API key.

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

### Description
Example request to retrieve the list of projects.

### Method
GET

### Endpoint
https://api.freelo.io/v1/projects

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```
curl -u your@email.tld:API_KEY -H 'User-Agent: Your_App_Id (email@company.tld)' \
    https://api.freelo.io/v1/projects
```

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

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

### Get Issued Invoices - C# Example

Source: https://freelo.docs.apiary.io/reference/invoicing/issued-invoices/issued-invoices-collection

Retrieves a list of issued invoices within a specified date range and for given project IDs. This C# example demonstrates how to make the API call.

```csharp
// C# example for fetching issued invoices would go here.
// Uses HttpClient from System.Net.Http.
```

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

### Projects Collection - Example

Source: https://freelo.docs.apiary.io/reference/notifications/create-api

Example of how to list projects using the Freelo API v1.

```APIDOC
## GET /v1/projects

### Description
Retrieves a collection of projects. This is an example endpoint demonstrating the request format.

### Method
GET

### Endpoint
`https://api.freelo.io/v1/projects`

### Parameters
#### Query Parameters
- **p** (integer) - Optional - The page number for paginated results, starting from 0.

### Headers
- **User-Agent** (string) - Required - A unique identifier for your application or your name.
- **Authorization** (string) - Required - Basic Authentication using email and API key.

### Request Example
```curl
curl -u your@email.tld:API_KEY -H 'User-Agent: Your_App_Id (email@company.tld)' \
    https://api.freelo.io/v1/projects
```

### Response
#### Success Response (200)
- **total** (integer) - The total number of projects available.
- **count** (integer) - The number of projects returned in this response.
- **page** (integer) - The current page number.
- **per_page** (integer) - The number of projects per page.
- **data** (object) - An object containing the project data.

#### Response Example
```json
{
    "total": 125,
    "count": 25,
    "page": 0,
    "per_page": 100,
    "data": { ... }
}
```
```

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

### Example: Projects List Request (curl)

Source: https://freelo.docs.apiary.io/introduction/create-task-with-special-url/create-api

Demonstrates how to fetch a list of projects using the curl command-line tool. It includes necessary authentication headers and the API endpoint.

```curl
curl -u your@email.tld:API_KEY -H 'User-Agent: Your_App_Id (email@company.tld)' \
    https://api.freelo.io/v1/projects

```

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

### Get Issued Invoices - Go Example

Source: https://freelo.docs.apiary.io/reference/invoicing/issued-invoices/issued-invoices-collection

Retrieves a list of issued invoices within a specified date range and for given project IDs. This Go example demonstrates how to make the API call.

```go
// Go example for fetching issued invoices would go here.
// Uses the standard library's 'net/http' package.
```

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

### Get Issued Invoices - Ruby Example

Source: https://freelo.docs.apiary.io/reference/invoicing/issued-invoices/issued-invoices-collection

Retrieves a list of issued invoices within a specified date range and for given project IDs. This Ruby example demonstrates how to make the API call.

```ruby
# Ruby example for fetching issued invoices would go here.
# Uses the 'net/http' library or gems like 'httparty'.
```

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

### Projects List Example

Source: https://freelo.docs.apiary.io/reference/projects/project-from-template

Example of how to retrieve a list of projects using the Freelo API v1.

```APIDOC
## GET /v1/projects

### Description
Retrieves a list of all projects accessible by the authenticated user.

### Method
GET

### Endpoint
`https://api.freelo.io/v1/projects`

### Parameters
#### Query Parameters
- **p** (integer) - Optional - The page number for pagination, starting from 0.

### Request Headers
- **User-Agent** (string) - Required - A string identifying the application making the request.
- **Authorization** (string) - Required - Basic Authentication with email and API key.

### Request Example
```bash
curl -u your@email.tld:API_KEY -H 'User-Agent: Your_App_Id (email@company.tld)' \
    https://api.freelo.io/v1/projects
```

### Response
#### Success Response (200)
- **total** (integer) - The total number of projects available.
- **count** (integer) - The number of projects returned in this response.
- **page** (integer) - The current page number.
- **per_page** (integer) - The number of projects per page.
- **data** (object) - An object containing the list of projects.

#### Response Example
```json
{
    "total": 125,
    "count": 25,
    "page": 0,
    "per_page": 100,
    "data": [
        {
            "id": 1,
            "name": "Project Alpha",
            "created_at": "2023-01-01T10:00:00Z",
            "updated_at": "2023-01-01T10:00:00Z"
        }
    ]
}
```
```

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

### Get Issued Invoices - PHP Example

Source: https://freelo.docs.apiary.io/reference/invoicing/issued-invoices/issued-invoices-collection

Retrieves a list of issued invoices within a specified date range and for given project IDs. This PHP example demonstrates how to make the API call.

```php
// PHP example for fetching issued invoices would go here.
// Uses cURL functions or libraries like Guzzle.
```

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

### Paginated Projects Example

Source: https://freelo.docs.apiary.io/reference/notes

Example of how to access a specific page of projects using the `p` query parameter.

```APIDOC
## GET /archived-projects?p=1

### Description
Retrieves a collection of archived projects, specifying the page number.

### Method
GET

### Endpoint
/archived-projects

### Query Parameters
- **p** (integer) - Required - The page number for pagination, starting from 0. Example: `p=1` for the second page.

### Request Example
```bash
curl -u your@email.tld:API_KEY -H 'User-Agent: Your_App_Id (email@company.tld)' \
    https://api.freelo.io/v1/archived-projects?p=1

```

### Response
#### Success Response (200)
- **total** (integer) - The total number of archived projects available.
- **count** (integer) - The number of archived projects returned in this response.
- **page** (integer) - The requested page number.
- **per_page** (integer) - The number of archived projects per page.
- **data** (object) - An object containing the archived project details.

#### Response Example
```json
{
    "total": 125,
    "count": 25,
    "page": 1,
    "per_page": 100,
    "data": { ... }
}
```
```

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

### Get Issued Invoices - Python Example

Source: https://freelo.docs.apiary.io/reference/invoicing/issued-invoices/issued-invoices-collection

Retrieves a list of issued invoices within a specified date range and for given project IDs. This Python example demonstrates how to make the API call.

```python
# Python example for fetching issued invoices would go here.
# Uses libraries like 'requests'.
```

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

### Projects Collection Example

Source: https://freelo.docs.apiary.io/reference/invoicing/issued-invoice-detail/create-api

Example of how to fetch a list of projects using curl.

```APIDOC
## GET /projects

### Description
Fetches a collection of projects.

### Method
GET

### Endpoint
https://api.freelo.io/v1/projects

### Parameters
#### Query Parameters
- **p** (integer) - Optional - The page number for paginated results, starting from 0.

### Request Example
```bash
curl -u your@email.tld:API_KEY -H 'User-Agent: Your_App_Id (email@company.tld)' \
    https://api.freelo.io/v1/projects
```

**Note:** `Your_App_Id` should describe the purpose of your API usage, or your name if unsure.

### Response
#### Success Response (200)
- **total** (integer) - The total number of projects available.
- **count** (integer) - The number of projects returned in this response.
- **page** (integer) - The current page number.
- **per_page** (integer) - The number of projects per page.
- **data** (object) - An object containing the project data.

#### Response Example
```json
{
    "total": 125,
    "count": 25,
    "page": 0,
    "per_page": 100,
    "data": { ... }
}
```
```

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

### Get Issued Invoices - Perl Example

Source: https://freelo.docs.apiary.io/reference/invoicing/issued-invoices/issued-invoices-collection

Retrieves a list of issued invoices within a specified date range and for given project IDs. This Perl example demonstrates how to make the API call.

```perl
# Perl example for fetching issued invoices would go here.
# Typically uses modules like LWP::UserAgent.
```

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

### Projects Collection Example

Source: https://freelo.docs.apiary.io/reference/files/download-file/create-api

Example of how to retrieve a list of projects using curl.

```APIDOC
## GET /projects

### Description
Retrieves a collection of projects.

### Method
GET

### Endpoint
`https://api.freelo.io/v1/projects`

### Parameters
#### Query Parameters
- **p** (integer) - Optional - The page number for pagination, starting from 0.

### Request Example
```bash
curl -u your@email.tld:API_KEY -H 'User-Agent: Your_App_Id (email@company.tld)' \
    https://api.freelo.io/v1/projects
```

### Response
#### Success Response (200)
- **total** (integer) - The total number of projects available.
- **count** (integer) - The number of projects returned in this response.
- **page** (integer) - The current page number.
- **per_page** (integer) - The number of projects per page.
- **data** (object) - An object containing the project data.

#### Response Example
```json
{
    "total": 125,
    "count": 25,
    "page": 0,
    "per_page": 100,
    "data": { ... }
}
```
```

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

### Get Issued Invoices - Node.js Example

Source: https://freelo.docs.apiary.io/reference/invoicing/issued-invoices/issued-invoices-collection

Retrieves a list of issued invoices within a specified date range and for given project IDs. This Node.js example demonstrates how to make the API call.

```javascript
// Node.js example for fetching issued invoices would go here.
// Commonly uses libraries like 'axios' or the built-in 'http' module.
```

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

### Projects List Example

Source: https://freelo.docs.apiary.io/introduction/paginated-response-format

Example of how to retrieve a list of projects using the Freelo API.

```APIDOC
## GET /v1/projects

### Description
Retrieves a list of all projects accessible by the authenticated user.

### Method
GET

### Endpoint
`https://api.freelo.io/v1/projects`

### Parameters
#### Query Parameters
- **p** (integer) - Optional - The page number for paginated results, starting from 0.

### Request Headers
- **User-Agent** (string) - Required - Identifies the client application.
- **Authorization** (string) - Required - Basic Authentication with email and API key.

### Request Example
```bash
curl -u your@email.tld:API_KEY -H 'User-Agent: Your_App_Id (email@company.tld)' \
    https://api.freelo.io/v1/projects
```

### Response
#### Success Response (200)
- **total** (integer) - The total number of projects available.
- **count** (integer) - The number of projects returned in this response.
- **page** (integer) - The current page number.
- **per_page** (integer) - The number of projects per page.
- **data** (object) - An object containing the project details.

#### Response Example
```json
{
    "total": 125,
    "count": 25,
    "page": 0,
    "per_page": 100,
    "data": {
        // ... project details ...
    }
}
```
```

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

### Projects List

Source: https://freelo.docs.apiary.io/reference/notes/create-api

Example of retrieving a list of projects using `curl` and HTTP Basic Authentication.

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

### Description
Example of retrieving a list of projects.

### Method
GET

### Endpoint
https://api.freelo.io/v1/projects

### Parameters
#### Headers
- **User-Agent**: Your_App_Id (email@company.tld)

### Request Example
```
curl -u your@email.tld:API_KEY -H 'User-Agent: Your_App_Id (email@company.tld)' \
    https://api.freelo.io/v1/projects
```

### Response
#### Success Response (200)
- Various project details.

#### Response Example
{
  "example": "response body"
}
```

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

### Get Issued Invoices - JavaScript Example

Source: https://freelo.docs.apiary.io/reference/invoicing/issued-invoices/issued-invoices-collection

Retrieves a list of issued invoices within a specified date range and for given project IDs. This JavaScript example demonstrates how to make the API call.

```javascript
// JavaScript example for fetching issued invoices would go here.
// This could use the fetch API or libraries like Axios.
```

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

### Projects List Example

Source: https://freelo.docs.apiary.io/reference/pinned-items/pinned-items-collection/pin-item-to-project

An example of retrieving a list of projects using cURL and HTTP Basic Authentication.

```APIDOC
## GET /v1/projects

### Description
Retrieve a list of projects.

### Method
GET

### Endpoint
https://api.freelo.io/v1/projects

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```
curl -u your@email.tld:API_KEY -H 'User-Agent: Your_App_Id (email@company.tld)' \
    https://api.freelo.io/v1/projects
```

### Response
#### Success Response (200)
- **total** (integer) - Total number of projects.
- **count** (integer) - Number of projects on the current page.
- **page** (integer) - Current page number.
- **per_page** (integer) - Number of projects per page.
- **data** (array) - An array of project objects.

#### Response Example
```json
{
    "total": 125,
    "count": 25,
    "page": 0,
    "per_page": 100,
    "data": {…}
}
```
```

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

### Get Issued Invoices - Java Example

Source: https://freelo.docs.apiary.io/reference/invoicing/issued-invoices/issued-invoices-collection

Retrieves a list of issued invoices within a specified date range and for given project IDs. This Java example demonstrates how to make the API call.

```java
// Java example for fetching issued invoices would go here.
// This would typically involve using an HTTP client library like Apache HttpClient or OkHttp.
```

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

### POST /projects

Source: https://freelo.docs.apiary.io/reference/project-labels/project-label/create-api

Create a new project with specified name, description, and settings.

```APIDOC
## POST /projects

### Description
Creates a new project in your Freelo account with the provided configuration.

### Method
POST

### Endpoint
`/projects`

### Request Body
- **name** (string) - Required - Project name (max 255 characters)
- **description** (string) - Optional - Project description
- **template_id** (integer) - Optional - ID of template to use
- **currency** (string) - Optional - Currency code (CZK, EUR, USD)

### Request Example
```bash
curl -X POST -u your@email.tld:API_KEY -H 'User-Agent: Your_App_Id' \
    -H 'Content-Type: application/json' \
    -d '{"name": "New Project", "description": "Project description"}' \
    https://api.freelo.io/v1/projects
```

### Response
#### Success Response (201)
- **id** (integer) - New project ID
- **name** (string) - Project name
- **status** (string) - Initial status
- **created_at** (string) - Creation timestamp

#### Response Example
```json
{
    "id": 789,
    "name": "New Project",
    "status": "active",
    "created_at": "2023-03-10T08:15:00Z"
}
```

#### Error Responses
- **400 Bad Request** - Invalid request body
- **422 Unprocessable Entity** - Validation errors
```

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

### Get Issued Invoices - cURL Example

Source: https://freelo.docs.apiary.io/reference/invoicing/issued-invoices/issued-invoices-collection

Retrieves a list of issued invoices within a specified date range and for given project IDs. This cURL example demonstrates how to make the API call.

```shell
curl -X GET https://api.freelo.io/v1/issued-invoices?date_range[date_from]="2023-11-07"&date_range[date_to]="2023-11-07"&projects_ids[0]=25
```

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

### Get Subtasks for Task (PHP)

Source: https://freelo.docs.apiary.io/reference/subtasks/subtasks-in-task/paginated-collection-of-subtasks-in-task

This PHP code example shows how to retrieve subtasks for a task ID using cURL. It sends a GET request to the Freelo API and processes the JSON response.

```php
// PHP example would go here, using cURL or file_get_contents with stream context.
```
Tokens:
Raw