### Example Response for Get All Deals

Source: https://developers.weeek.net/api/deals

This is an example of a successful response when retrieving deals. It includes a list of deals, each with detailed information and custom fields.

```json
{
  "success": true,
  "deals": [
    {
      "id": "id",
      "creatorId": "00000000-0000-0000-0000-000000000000",
      "funnelId": "funnelId",
      "statusId": "statusId",
      "assignees": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "organizations": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "contacts": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "title": {},
      "description": {},
      "amount": {},
      "winStatus": "won",
      "createdAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z",
      "tags": [
        0
      ],
      "tasks": [
        {
          "id": 0,
          "parentId": {},
          "title": "title",
          "description": {},
          "duration": {},
          "overdue": 0,
          "type": "action",
          "priority": {},
          "isCompleted": true,
          "isDeleted": true,
          "authorId": "authorId",
          "assignees": {},
          "locations": [
            {
              "projectId": 0,
              "boardId": {},
              "boardColumnId": {}
            }
          ],
          "image": {},
          "isPrivate": true,
          "startDate": "2024-08-25",
          "startDateTime": "2024-08-25T15:00:00Z",
          "dueDate": "2024-08-25",
          "dueDateTime": "2024-08-25T15:00:00Z",
          "createdAt": "2024-08-25T15:00:00Z",
          "updatedAt": "2024-08-25T15:00:00Z",
          "tags": [
            0
          ],
          "subscribers": [
            "string"
          ],
          "subTasks": [
            0
          ],
          "timeEntries": [
            {
              "id": "00000000-0000-0000-0000-000000000000",
              "userId": "00000000-0000-0000-0000-000000000000",
              "type": 1,
              "isOvertime": true,
              "date": "2024-08-25",
              "duration": 0,
              "durationSeconds": 0,
              "comment": "comment"
            }
          ],
          "customFields": [
            {
              "id": "00000000-0000-0000-0000-000000000000",
              "name": {},
              "type": "text",
              "config": {
                "type": "number",
                "precision": {},
                "currency": 1
              },
              "options": [
                {
                  "id": "00000000-0000-0000-0000-000000000000",
                  "name": "name",
                  "color": "blue"
                }
              ],
              "value": []
            }
          ],
          "attachments": [
            {
              "id": "00000000-0000-0000-0000-000000000000",
              "creatorId": "00000000-0000-0000-0000-000000000000",
              "service": "weeek",
              "name": "name",
              "url": "https://www.example.com/path/to/resource",
              "size": 0,
              "createdAt": "2024-08-25T15:00:00Z"
            }
          ]
        }
      ],
      "customFields": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "name": {},
          "type": "text",
          "config": {
            "type": "number",
            "precision": {},
            "currency": 1
          },
          "options": [
            {
              "id": "00000000-0000-0000-0000-000000000000",
              "name": "name",
              "color": "blue"
            }
          ],
          "value": "string"
        }
      ],
      "attachments": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "creatorId": "00000000-0000-0000-0000-000000000000",
          "service": "weeek",
          "name": "name",
          "url": "https://www.example.com/path/to/resource",
          "size": 0,
          "createdAt": "2024-08-25T15:00:00Z"
        }
      ]
    }
  ],
  "hasMoreDeals": true
}
```

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

### Example Response for Get Portfolios

Source: https://developers.weeek.net/api/portfolio

A successful response for the 'Get portfolios' endpoint, showing the structure of the returned data.

```json
{
  "success": true,
  "data": [
    {
      "id": 0,
      "name": "name",
      "parentId": {},
      "isPrivate": true
    }
  ],
  "hasMore": true
}
```

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

### Example Response for Get All Organizations

Source: https://developers.weeek.net/api/organizations

Illustrates the structure of a successful response when retrieving organizations.

```json
{
  "success": true,
  "organizations": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "creatorId": "00000000-0000-0000-0000-000000000000",
      "name": "name",
      "responsibleId": "00000000-0000-0000-0000-000000000000",
      "addresses": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "address": "address"
        }
      ],
      "emails": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "email": "test@example.com"
        }
      ],
      "phones": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "phone": "phone"
        }
      ],
      "contacts": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "tags": [
        0
      ],
      "createdAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z"
    }
  ]
}
```

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

### Example Response for Get All Contacts

Source: https://developers.weeek.net/api/contacts

Illustrates the structure of a successful response when retrieving contacts.

```json
{
  "success": true,
  "contacts": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "creatorId": "00000000-0000-0000-0000-000000000000",
      "lastName": {},
      "firstName": "firstName",
      "middleName": {},
      "organizations": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "emails": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "email": "test@example.com"
        }
      ],
      "phones": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "phone": "phone"
        }
      ],
      "tags": [
        0
      ],
      "createdAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z"
    }
  ]
}
```

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

### Example Project List Response

Source: https://developers.weeek.net/api/project

An example of a successful response when retrieving a list of projects. It includes project details such as ID, name, status, and custom fields.

```json
{
  "success": true,
  "projects": [
    {
      "id": 0,
      "name": "name",
      "logoLink": {},
      "description": {},
      "color": "color",
      "status": 1,
      "isPrivate": true,
      "portfolioId": {},
      "team": [
        "string"
      ],
      "customFields": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "name": {},
          "type": "text",
          "config": {
            "type": "number",
            "precision": {},
            "currency": 1
          },
          "options": [
            {
              "id": "00000000-0000-0000-0000-000000000000",
              "name": "name",
              "color": "blue"
            }
          ]
        }
      ]
    }
  ]
}
```

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

### Example Response for Get Board Column List

Source: https://developers.weeek.net/api/board-column

Illustrates the structure of a successful response when retrieving board columns.

```json
{
  "success": true,
  "boardColumns": [
    {
      "id": 0,
      "name": "name",
      "boardId": 0
    }
  ]
}
```

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

### Example Task Response (JSON)

Source: https://developers.weeek.net/api/task

This is an example of a successful response when retrieving tasks. It includes task details such as ID, title, completion status, and associated data.

```json
{
  "success": true,
  "tasks": [
    {
      "id": 0,
      "parentId": 0,
      "title": "string",
      "description": "string",
      "date": "string",
      "time": "string",
      "duration": 60,
      "type": "action",
      "priority": 0,
      "isCompleted": 1,
      "isDeleted": false,
      "authorId": "string",
      "assignees": [],
      "boardId": 0,
      "boardColumnId": 0,
      "projectId": 0,
      "image": "string",
      "isPrivate": true,
      "dateStart": "2019-08-24",
      "dateEnd": "2019-08-24",
      "timeStart": "14:15:22Z",
      "timeEnd": "14:15:22Z",
      "tags": [
        0
      ],
      "subscribers": [
        "string"
      ],
      "timeEntries": [
        {
          "id": "bc92d5f2-3aaf-49cc-8010-5007ced66ea6",
          "userId": "24d20bfa-bc7e-471e-8c17-a199734532dc",
          "type": 2,
          "isOvertime": false,
          "date": "05.10.2022",
          "duration": 60,
          "durationSeconds": 5,
          "comment": null
        }
      ]
    }
  ],
  "hasMore": true
}
```

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

### Workspace Info API Response Example

Source: https://developers.weeek.net/api/workspace

This is an example of a successful 200 OK response when requesting workspace information.

```json
{
  "success": true,
  "workspace": {
    "id": 1,
    "title": "info@weeek.net",
    "description": null,
    "isPersonal": true,
    "logo": "https://storage.weeek.net/img/no_image.png"
  }
}
```

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

### Deal Custom Fields Example

Source: https://developers.weeek.net/api/~schemas

Shows the format for custom fields when creating or updating a deal. It includes examples for text, boolean, datetime, select, multiselect, member, contact, link, and approval custom field types.

```json
"customFields" : {
    "<text_custom_field_id>": "Text value",
    "<boolean_custom_field_id>": true,
    "<datetime_custom_field_id>": "<ISO 8601 datetime string>",
    "<select_custom_field_id>": "<custom_field_option_id>"
    "<multiselect_custom_field_id>": ["<custom_field_option_id>"],
    "<member_custom_field_id>": ["<user_id>"],
    "<contact_custom_field_id>": "<contact_id>",
    "<link_custom_field_id>": "https://example.com",
    "<approval_custom_field_id>": ["<user_id>"]
}
```

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

### Example Response for Get All Funnel Statuses

Source: https://developers.weeek.net/api/funnel-statuses

Illustrates the structure of a successful response when retrieving all funnel statuses.

```json
{
  "success": true,
  "statuses": [
    {
      "id": "id",
      "creatorId": "00000000-0000-0000-0000-000000000000",
      "name": "name",
      "dealsCount": 0,
      "dealsAmount": 0,
      "createdAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z"
    }
  ]
}
```

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

### Example Response for Get All Currencies

Source: https://developers.weeek.net/api/currencies

This is a sample JSON response when successfully retrieving all currencies. It indicates success and provides an array of currency objects, each with an id, name, code, and symbol.

```json
{
  "success": true,
  "currencies": [
    {
      "id": 0,
      "name": "name",
      "code": "code",
      "symbol": "symbol"
    }
  ]
}
```

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

### Start task timer

Source: https://developers.weeek.net/api/task

Starts the timer for a specific task.

```APIDOC
## Start task timer

### Description
Starts the timer for a specific task.

### Method
POST

### Endpoint
/tm/tasks/{id}/start-timer

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the task to start the timer for.

### Response
#### Success Response (200)
- **success** (boolean) - Required

### Response Example
```json
{
  "success": true
}
```
```

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

### Tag List Response Example

Source: https://developers.weeek.net/api/tags

Example of a successful response when listing tags, including success status and a list of tag objects.

```json
{
  "success": true,
  "tags": [
    {
      "id": 0,
      "title": "title",
      "color": "color"
    }
  ]
}
```

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

### Attachment Response Example

Source: https://developers.weeek.net/api/attachments

This is an example of a successful response when retrieving attachment details. It includes metadata such as ID, creator, service, name, URL, size, and creation date.

```json
{
  "success": true,
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "creatorId": "00000000-0000-0000-0000-000000000000",
    "service": "weeek",
    "name": "name",
    "url": "https://www.example.com/path/to/resource",
    "size": 0,
    "createdAt": "2024-08-25T15:00:00Z"
  }
}
```

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

### Get board list

Source: https://developers.weeek.net/api/board

Retrieves a list of boards. Optionally filter by projectId.

```curl
curl --request GET \
  --url https://api.weeek.net/public/v1/tm/boards
```

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

### Create Global Custom Field Request Body Example

Source: https://developers.weeek.net/api/custom-fields

Provides an example of the JSON payload required to create a new global custom field, specifying its name, type, and configuration details.

```json
{
  "name": {}, 
  "type": "text", 
  "config": {
    "type": "number", 
    "precision": {}, 
    "currency": 1
  }
}
```

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

### Get Portfolios

Source: https://developers.weeek.net/api/portfolio

Retrieves a list of portfolios. Supports searching and pagination.

```curl
curl --request GET \
  --url https://api.weeek.net/public/v1/tm/portfolios
```

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

### User Profile Response Example

Source: https://developers.weeek.net/api/user

This JSON object illustrates a successful response when fetching a user's profile.

```json
{
  "success": true,
  "user": {
    "id": "id",
    "email": "email",
    "logoLink": "logoLink",
    "lastName": {},
    "firstName": {},
    "middleName": {},
    "about": {},
    "position": {},
    "language": "language",
    "birthDate": {},
    "country": {},
    "timeZone": "timeZone",
    "phoneNumber": {}
  }
}
```

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

### Get Global Custom Fields

Source: https://developers.weeek.net/api/custom-fields

Retrieves a list of all global custom fields available in the account. This is a simple GET request to the specified endpoint.

```curl
curl --request GET \
  --url https://api.weeek.net/public/v1/tm/custom-fields
```

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

### Get Project List

Source: https://developers.weeek.net/api/project

Retrieves a list of projects. This endpoint is used to fetch all projects associated with the authenticated user.

```shell
curl --request GET \
  --url https://api.weeek.net/public/v1/tm/projects
```

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

### Get portfolio

Source: https://developers.weeek.net/api/portfolio

Retrieves a specific portfolio by its ID.

```APIDOC
## Get portfolio

### Description
Retrieves a specific portfolio by its ID.

### Method
GET

### Endpoint
https://api.weeek.net/public/v1/tm/portfolios/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required

### Responses
#### Success Response (200)
- **success** (boolean) - required
- **data** (object) - required
```

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

### Get a deal

Source: https://developers.weeek.net/api/deals

Retrieves a specific deal by its ID.

```APIDOC
## Get a deal

### Description
Retrieves a specific deal by its ID.

### Method
GET

### Endpoint
https://api.weeek.net/public/v1/crm/deals/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the deal.

### Response
#### Success Response (200)
- **success** (boolean)
- **deal** (object)

#### Response Example
```json
{
  "success": true,
  "deal": {}
}
```
```

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

### Get All Organizations

Source: https://developers.weeek.net/api/organizations

Retrieves a list of all organizations. Supports filtering, sorting, and pagination.

```curl
curl --request GET \
  --url https://api.weeek.net/public/v1/crm/organizations
```

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

### Create Global Custom Field Response Example

Source: https://developers.weeek.net/api/custom-fields

Illustrates a successful response after creating a global custom field, including the success status and details of the newly created custom field.

```json
{
  "success": true, 
  "customField": {
    "id": "9df95ae9-43b3-485a-8789-9f2d04c0e725", 
    "name": "string", 
    "type": "text"
  }
}
```

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

### Get board list

Source: https://developers.weeek.net/api/board

Retrieves a list of boards, optionally filtered by a project ID.

```APIDOC
## GET /tm/boards

### Description
Retrieves a list of boards, optionally filtered by a project ID.

### Method
GET

### Endpoint
`https://api.weeek.net/public/v1/tm/boards`

### Parameters
#### Query Parameters
- **projectId** (integer) - optional

### Response
#### Success Response (200)
- **success** (boolean)
- **boards** (object[])

### Response Example
```json
{
  "success": true,
  "boards": [
    {
      "id": 0,
      "name": "name",
      "projectId": 0,
      "isPrivate": true
    }
  ]
}
```
```

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

### Get project

Source: https://developers.weeek.net/api/project

Retrieves a specific project by its ID. Returns a success status and the project object.

```APIDOC
## Get project

### Description
Retrieves a specific project by its ID. Returns a success status and the project object.

### Method
GET

### Endpoint
https://api.weeek.net/public/v1/tm/projects/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required.

### Responses
#### Success Response (200)
- `success` (boolean)
- `project` (object)
```

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

### Get Project by ID

Source: https://developers.weeek.net/api/project

Retrieves a specific project by its ID. Requires the project ID as a path parameter.

```shell
GET https://api.weeek.net/public/v1/tm/projects/{id}

path Parameters:
  * `id`string · required
```

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

### Authorization Header Example

Source: https://developers.weeek.net/

All API requests must include an 'Authorization' header with a bearer token. Obtain your token from the workspace settings.

```http
Authorization: Bearer 123e4567-e89b-12d3-a456-426655440000
```

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

### Get profile

Source: https://developers.weeek.net/api/user

Retrieves the profile information for the currently authenticated user.

```APIDOC
## GET /user/me

### Description
Retrieves the profile information for the currently authenticated user.

### Method
GET

### Endpoint
https://api.weeek.net/public/v1/user/me

### Responses
#### Success Response (200)
- `success` (boolean)
- `user` (object)
  - `id` (string)
  - `email` (string)
  - `logoLink` (string)
  - `lastName` (object)
  - `firstName` (object)
  - `middleName` (object)
  - `about` (object)
  - `position` (object)
  - `language` (string)
  - `birthDate` (object)
  - `country` (object)
  - `timeZone` (string)
  - `phoneNumber` (object)

### Request Example
```curl
curl --request GET \
  --url https://api.weeek.net/public/v1/user/me
```

### Response Example
```json
{
  "success": true,
  "user": {
    "id": "id",
    "email": "email",
    "logoLink": "logoLink",
    "lastName": {},
    "firstName": {},
    "middleName": {},
    "about": {},
    "position": {},
    "language": "language",
    "birthDate": {},
    "country": {},
    "timeZone": "timeZone",
    "phoneNumber": {}
  }
}
```
```

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

### Get project list

Source: https://developers.weeek.net/api/project

Retrieves a list of projects. Returns a success status and an array of project objects.

```APIDOC
## Get project list

### Description
Retrieves a list of projects. Returns a success status and an array of project objects.

### Method
GET

### Endpoint
https://api.weeek.net/public/v1/tm/projects

### Responses
#### Success Response (200)
- `success` (boolean)
- `projects` (object[])

### Request Example
```curl
curl --request GET \
  --url https://api.weeek.net/public/v1/tm/projects
```
```

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

### Get Portfolio by ID

Source: https://developers.weeek.net/api/portfolio

Retrieves a specific portfolio using its unique ID.

```http
GET https://api.weeek.net/public/v1/tm/portfolios/{id}
```

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

### Start Task Timer API Endpoint

Source: https://developers.weeek.net/api/task

Initiates the timer for a specific task. Requires the task ID in the URL.

```http
POST https://api.weeek.net/public/v1
/tm/tasks/{id}/start-timer
```

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

### Get All Deals

Source: https://developers.weeek.net/api/deals

Retrieves a list of deals associated with a specific status ID. The response includes deal details and a flag indicating if more deals are available.

```curl
curl --request GET \
  --url https://api.weeek.net/public/v1/crm/statuses/:statusId/deals
```

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

### Get Board Column List

Source: https://developers.weeek.net/api/board-column

Retrieves a list of all board columns. Requires a board ID as a query parameter.

```curl
curl --request GET \
  --url https://api.weeek.net/public/v1/tm/board-columns
```

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

### Get a Contact by ID

Source: https://developers.weeek.net/api/contacts

Retrieves a specific contact using its unique identifier.

```path
/crm/contacts/{id}
```

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

### Get workspace info

Source: https://developers.weeek.net/api/workspace

Retrieves the information for the current workspace associated with the provided token.

```APIDOC
## GET /ws

### Description
Get workspace info for current token.

### Method
GET

### Endpoint
https://api.weeek.net/public/v1/ws

### Responses
#### Success Response (200)
- **success** (boolean)
- **workspace** (object)

### Request Example
```json
{
  "success": true,
  "workspace": {
    "id": 1,
    "title": "info@weeek.net",
    "description": null,
    "isPersonal": true,
    "logo": "https://storage.weeek.net/img/no_image.png"
  }
}
```
```

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

### Time Entry Overtime Flag Example

Source: https://developers.weeek.net/api/~schemas

Demonstrates the use of the `isOvertime` boolean parameter for time entries. Note that it requires 0 or 1 instead of false or true.

```json
"isOvertime": 0
```

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

### Get all funnels

Source: https://developers.weeek.net/api/funnels

Retrieves a list of all funnels. Includes basic information about each funnel.

```APIDOC
## GET /crm/funnels

### Description
Retrieves a list of all funnels.

### Method
GET

### Endpoint
https://api.weeek.net/public/v1/crm/funnels

### Responses
#### Success Response (200)
- `success` (boolean)
- `funnels` (object[])
```

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

### Get all organizations

Source: https://developers.weeek.net/api/organizations

Retrieves a list of all organizations, with options for filtering, sorting, and pagination.

```APIDOC
## Get all organizations
GET
https://api.weeek.net/public/v1/crm/organizations

### Description
Retrieves a list of all organizations.

### Method
GET

### Endpoint
https://api.weeek.net/public/v1/crm/organizations

### Query Parameters
- **search** (string | null) - Allows searching for organizations.
- **responsible** (string[]) - Filters organizations by responsible IDs.
- **contacts** (string[]) - Filters organizations by contact IDs.
- **tags** (string[]) - Filters organizations by tag IDs.
- **customFields[*][id]** (string) - Custom field ID for filtering.
- **customFields[*][value]** (string) - Custom field value for filtering.
- **limit** (integer) - The number of objects to return.
- **offset** (integer) - The number of objects to skip.
- **sort** (string) - Sorts in ascending order of the specified parameter. To sort in descending order, prepend a minus sign (e.g., -alphabet). Enum values: alphabet, updatedAt.

### Responses
#### Success Response (200)
- **success** (boolean)
- **organizations** (object[])
```

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

### Get workspace members

Source: https://developers.weeek.net/api/workspace

Retrieves a list of members for the current workspace.

```APIDOC
## GET /ws/members

### Description
Get workspace members for current workspace.

### Method
GET

### Endpoint
https://api.weeek.net/public/v1/ws/members

### Responses
#### Success Response (200)
- **success** (boolean)
- **members** (object[])
```

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

### Get all deals

Source: https://developers.weeek.net/api/deals

Retrieves a list of deals from the CRM, with extensive filtering and sorting capabilities.

```APIDOC
## GET /crm/statuses/{statusId}/deals

### Description
Retrieves a list of deals associated with a specific status ID. Supports filtering by search terms, assignee IDs, win statuses, last updated dates, tags, organizations, contacts, custom fields, and pagination.

### Method
GET

### Endpoint
https://api.weeek.net/public/v1/crm/statuses/{statusId}/deals

### Parameters
#### Path Parameters
- **statusId** (string) - Required - The ID of the status to filter deals by.

#### Query Parameters
- **search** (string) - Optional - Filters deals by a search term.
- **assigneeIds** (string[]) - Optional - Filters deals by assignee IDs.
- **winStatuses** (string[]) - Optional - Filters deals by win status (won, lost, archived).
- **lastUpdated** (string[]) - Optional - Filters deals by last updated date (today, yesterday, lastWeek).
- **tags** (string[]) - Optional - Filters deals by tags.
- **organizations** (string[]) - Optional - Filters deals by organization.
- **contacts** (string[]) - Optional - Filters deals by contact.
- **customFields[*][id]** (string) - Optional - Filters deals by custom field ID.
- **customFields[*][value]** (string) - Optional - Filters deals by custom field value.
- **limit** (integer) - Optional - The number of objects to return.
- **offset** (integer) - Optional - The number of objects to skip.
- **sort** (string) - Optional - Sorts deals in ascending order of the specified parameter. Prepend a minus sign for descending order (e.g., -title). Enum values: title, amount, commented, createdAt, updatedAt.
```

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

### Get all deals

Source: https://developers.weeek.net/api/deals

Retrieves a list of deals associated with a specific status. Supports pagination with `hasMoreDeals`.

```APIDOC
## GET /crm/statuses/{statusId}/deals

### Description
Retrieves a list of deals for a given status ID. The response includes a boolean indicating if more deals are available.

### Method
GET

### Endpoint
/crm/statuses/{statusId}/deals

### Parameters
#### Path Parameters
- **statusId** (string) - Required - The ID of the status to filter deals by.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **deals** (object[]) - An array of deal objects.
- **hasMoreDeals** (boolean) - Indicates if there are more deals available beyond the current response.

### Response Example
```json
{
  "success": true,
  "deals": [
    {
      "id": "id",
      "creatorId": "00000000-0000-0000-0000-000000000000",
      "funnelId": "funnelId",
      "statusId": "statusId",
      "assignees": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "organizations": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "contacts": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "title": {},
      "description": {},
      "amount": {},
      "winStatus": "won",
      "createdAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z",
      "tags": [
        0
      ],
      "tasks": [
        {
          "id": 0,
          "parentId": {},
          "title": "title",
          "description": {},
          "duration": {},
          "overdue": 0,
          "type": "action",
          "priority": {},
          "isCompleted": true,
          "isDeleted": true,
          "authorId": "authorId",
          "assignees": {},
          "locations": [
            {
              "projectId": 0,
              "boardId": {},
              "boardColumnId": {}
            }
          ],
          "image": {},
          "isPrivate": true,
          "startDate": "2024-08-25",
          "startDateTime": "2024-08-25T15:00:00Z",
          "dueDate": "2024-08-25",
          "dueDateTime": "2024-08-25T15:00:00Z",
          "createdAt": "2024-08-25T15:00:00Z",
          "updatedAt": "2024-08-25T15:00:00Z",
          "tags": [
            0
          ],
          "subscribers": [
            "string"
          ],
          "subTasks": [
            0
          ],
          "timeEntries": [
            {
              "id": "00000000-0000-0000-0000-000000000000",
              "userId": "00000000-0000-0000-0000-000000000000",
              "type": 1,
              "isOvertime": true,
              "date": "2024-08-25",
              "duration": 0,
              "durationSeconds": 0,
              "comment": "comment"
            }
          ],
          "customFields": [
            {
              "id": "00000000-0000-0000-0000-000000000000",
              "name": {},
              "type": "text",
              "config": {
                "type": "number",
                "precision": {},
                "currency": 1
              },
              "options": [
                {
                  "id": "00000000-0000-0000-0000-000000000000",
                  "name": "name",
                  "color": "blue"
                }
              ],
              "value": []
            }
          ],
          "attachments": [
            {
              "id": "00000000-0000-0000-0000-000000000000",
              "creatorId": "00000000-0000-0000-0000-000000000000",
              "service": "weeek",
              "name": "name",
              "url": "https://www.example.com/path/to/resource",
              "size": 0,
              "createdAt": "2024-08-25T15:00:00Z"
            }
          ]
        }
      ],
      "customFields": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "name": {},
          "type": "text",
          "config": {
            "type": "number",
            "precision": {},
            "currency": 1
          },
          "options": [
            {
              "id": "00000000-0000-0000-0000-000000000000",
              "name": "name",
              "color": "blue"
            }
          ],
          "value": "string"
        }
      ],
      "attachments": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "creatorId": "00000000-0000-0000-0000-000000000000",
          "service": "weeek",
          "name": "name",
          "url": "https://www.example.com/path/to/resource",
          "size": 0,
          "createdAt": "2024-08-25T15:00:00Z"
        }
      ]
    }
  ],
  "hasMoreDeals": true
}
```
```

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

### Get All Currencies

Source: https://developers.weeek.net/api/currencies

Use this cURL command to fetch a list of all available currencies from the Weeek API. The response includes success status and an array of currency objects.

```curl
curl --request GET \
  --url https://api.weeek.net/public/v1/crm/currencies
```

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

### Get global custom fields

Source: https://developers.weeek.net/api/custom-fields

Retrieves a list of all global custom fields available in the system.

```APIDOC
## Get global custom fields

### Description
Retrieves a list of all global custom fields.

### Method
GET

### Endpoint
https://api.weeek.net/public/v1/tm/custom-fields

### Response
#### Success Response (200)
An empty JSON object is returned upon success.

#### Response Example
```json
{}
```
```

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

### Get one task info

Source: https://developers.weeek.net/api/task

Retrieves detailed information for a specific task by its ID.

```APIDOC
## Get one task info

### Description
Retrieves detailed information for a specific task by its ID.

### Method
GET

### Endpoint
https://api.weeek.net/public/v1/tm/tasks/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required. The unique identifier of the task.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **task** (object) - The task object with its details.
```

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

### Get Workspace Info using cURL

Source: https://developers.weeek.net/api/workspace

Use this cURL command to retrieve information about the current workspace associated with your token.

```curl
curl --request GET \
  --url https://api.weeek.net/public/v1/ws
```

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

### Create Project

Source: https://developers.weeek.net/api/project

Creates a new project. Requires project name, logo, privacy status, and description. Portfolio ID is optional.

```shell
POST https://api.weeek.net/public/v1/tm/projects

Request Body:
  * `name`string · minLength: 1 · required
  * `logo`string | null · minLength: 1 · required
  * `isPrivate`boolean · required
You must use 0 or 1 instead of false or true
  * `description`string | null · required


  * `portfolioId`integer
```

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

### Get portfolios

Source: https://developers.weeek.net/api/portfolio

Retrieves a list of portfolios. Supports searching by name and filtering by parent ID. Pagination is available with limit and offset parameters.

```APIDOC
## Get portfolios

### Description
Retrieves a list of portfolios. Supports searching by name and filtering by parent ID. Pagination is available with limit and offset parameters.

### Method
GET

### Endpoint
https://api.weeek.net/public/v1/tm/portfolios

### Parameters
#### Query Parameters
- **search** (string) - Optional - Search by portfolio name
- **parentId** (integer) - Optional
- **limit** (integer) - Optional - max: 100
- **offset** (integer) - Optional

### Responses
#### Success Response (200)
- **success** (boolean) - required
- **data** (object[]) - required
- **hasMore** (boolean) - required

#### Response Example
```json
{
  "success": true,
  "data": [
    {
      "id": 0,
      "name": "name",
      "parentId": {},
      "isPrivate": true
    }
  ],
  "hasMore": true
}
```
```

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

### Time Entry Request Overtime Flag Example

Source: https://developers.weeek.net/api/~schemas

Shows the `isOvertime` parameter in a time entry request. This boolean flag must be represented as 0 for false or 1 for true.

```json
"isOvertime": 1
```

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

### Get tasks

Source: https://developers.weeek.net/api/task

Retrieves a list of tasks based on various query parameters. Supports filtering, sorting, and pagination.

```APIDOC
## Get tasks

### Description
Retrieves a list of tasks based on various query parameters. Supports filtering, sorting, and pagination.

### Method
GET

### Endpoint
https://api.weeek.net/public/v1/tm/tasks

### Parameters
#### Query Parameters
- **day** (string) - Filters tasks for a specific day.
- **userId** (string) - Filters tasks by user ID.
- **projectId** (integer) - Filters tasks by project ID.
- **completed** (boolean) - Filters tasks by completion status. Accepts 0 or 1.
- **boardId** (integer) - Filters tasks by board ID.
- **boardColumnId** (integer) - Filters tasks by board column ID.
- **type** (string) - Filters tasks by type.
- **priority** (integer) - Filters tasks by priority (0: Low, 1: Medium, 2: High, 3: Hold).
- **tags** (string[]) - Filters tasks by an array of tag IDs.
- **search** (string) - Searches for tasks by text in title and description.
- **perPage** (integer) - Number of tasks to return per page.
- **offset** (integer) - Offset for pagination.
- **sortBy** (string) - Sorts tasks. Prepend '-' for descending order. Enum values: name, type, priority, duration, overdue, created, date, start.
- **startDate** (string) - Start date for filtering (dd.mm.yyyy). Required with endDate.
- **endDate** (string) - End date for filtering (dd.mm.yyyy). Required with startDate.
- **all** (boolean) - Shows all tasks, including deleted and completed. If present, `completed` is ignored. Accepts 0 or 1.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **tasks** (object[]) - An array of task objects.
- **hasMore** (boolean) - Indicates if there are more tasks available.

#### Response Example
```json
{
  "success": true,
  "tasks": [
    {
      "id": 0,
      "parentId": 0,
      "title": "string",
      "description": "string",
      "date": "string",
      "time": "string",
      "duration": 60,
      "type": "action",
      "priority": 0,
      "isCompleted": 1,
      "isDeleted": false,
      "authorId": "string",
      "assignees": [],
      "boardId": 0,
      "boardColumnId": 0,
      "projectId": 0,
      "image": "string",
      "isPrivate": true,
      "dateStart": "2019-08-24",
      "dateEnd": "2019-08-24",
      "timeStart": "14:15:22Z",
      "timeEnd": "14:15:22Z",
      "tags": [
        0
      ],
      "subscribers": [
        "string"
      ],
      "timeEntries": [
        {
          "id": "bc92d5f2-3aaf-49cc-8010-5007ced66ea6",
          "userId": "24d20bfa-bc7e-471e-8c17-a199734532dc",
          "type": 2,
          "isOvertime": false,
          "date": "05.10.2022",
          "duration": 60,
          "durationSeconds": 5,
          "comment": null
        }
      ]
    }
  ],
  "hasMore": true
}
```
```

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

### Create board

Source: https://developers.weeek.net/api/board

Creates a new board within a specified project. Requires board name and project ID.

```curl
curl --request POST \
  --url https://api.weeek.net/public/v1/tm/boards
```

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

### Task Custom Fields Example

Source: https://developers.weeek.net/api/~schemas

Illustrates the structure for custom fields in a task update request. Supports various data types like text, boolean, datetime, select, multiselect, member, contact, link, and approval.

```json
"customFields" : {
    "<text_custom_field_id>": "Text value",
    "<boolean_custom_field_id>": true,
    "<datetime_custom_field_id>": "<ISO 8601 datetime string>",
    "<select_custom_field_id>": "<custom_field_option_id>"
    "<multiselect_custom_field_id>": ["<custom_field_option_id>"],
    "<member_custom_field_id>": ["<user_id>"],
    "<contact_custom_field_id>": "<contact_id>",
    "<link_custom_field_id>": "Link value",
    "<approval_custom_field_id>": ["<user_id>"]
}
```

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

### Get all currencies

Source: https://developers.weeek.net/api/currencies

Retrieves a list of all currencies supported by the Weeek platform. The response includes a success status and an array of currency objects, each containing an id, name, code, and symbol.

```APIDOC
## GET /crm/currencies

### Description
Retrieves a list of all currencies supported by the Weeek platform.

### Method
GET

### Endpoint
https://api.weeek.net/public/v1/crm/currencies

### Responses
#### Success Response (200)
- `success` (boolean) - Indicates if the request was successful.
- `currencies` (object[]) - An array of currency objects.
  - `id` (integer) - The unique identifier for the currency.
  - `name` (string) - The name of the currency.
  - `code` (string) - The currency code (e.g., USD, EUR).
  - `symbol` (string) - The currency symbol (e.g., $, €).

### Request Example
```
curl --request GET \
  --url https://api.weeek.net/public/v1/crm/currencies
```

### Response Example
```json
{
  "success": true,
  "currencies": [
    {
      "id": 0,
      "name": "name",
      "code": "code",
      "symbol": "symbol"
    }
  ]
}
```
```

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

### Create project

Source: https://developers.weeek.net/api/project

Creates a new project with the provided details. Requires name, logo, isPrivate status, and description. Optionally accepts a portfolioId.

```APIDOC
## Create project

### Description
Creates a new project with the provided details. Requires name, logo, isPrivate status, and description. Optionally accepts a portfolioId.

### Method
POST

### Endpoint
https://api.weeek.net/public/v1/tm/projects

### Parameters
#### Request Body
- **name** (string) - Required - Minimum length of 1.
- **logo** (string | null) - Required - Minimum length of 1.
- **isPrivate** (boolean) - Required - Use 0 or 1 instead of false or true.
- **description** (string | null) - Required.
- **portfolioId** (integer) - Optional.

### Responses
#### Success Response (200)
- `success` (boolean)
- `project` (object)
```

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

### Get a Funnel Status

Source: https://developers.weeek.net/api/funnel-statuses

Retrieves a specific funnel status by its ID. Requires the status ID as a path parameter.

```GET
GET https://api.weeek.net/public/v1/crm/statuses{id}
```