### GET /v1/workspaces

Source: https://api.hothawk.ai/docs/public-json

Fetches all team workspaces.

```APIDOC
## GET /v1/workspaces

### Description
Fetches all team workspaces associated with the authenticated account.

### Method
GET

### Endpoint
/v1/workspaces

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **workspaces** (array) - A list of workspace objects.
  - **id** (string) - The unique identifier of the workspace.
  - **name** (string) - The name of the workspace.

#### Response Example
```json
{
  "workspaces": [
    {
      "id": "d1f8b00d-5aef-4d2f-b5fd-49d00e93cfa1",
      "name": "My Workspace"
    }
  ]
}
```
```

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

### GET /v1/labels

Source: https://api.hothawk.ai/docs/public-json

Fetches all available labels.

```APIDOC
## GET /v1/labels

### Description
Fetches all labels that can be applied to threads or other entities.

### Method
GET

### Endpoint
/v1/labels

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **labels** (array) - A list of label objects.
  - **id** (string) - The unique identifier of the label.
  - **name** (string) - The name of the label.
  - **color** (string) - The color associated with the label.

#### Response Example
```json
{
  "labels": [
    {
      "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
      "name": "Urgent",
      "color": "#FF0000"
    }
  ]
}
```
```

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

### Get Workspaces

Source: https://api.hothawk.ai/docs/public-json

Fetches a list of workspaces accessible by the authenticated user.

```APIDOC
## GET /v1/workspaces

### Description
Fetches all available workspaces for the authenticated user.

### Method
GET

### Endpoint
/v1/workspaces

### Responses
#### Success Response (200)
- **array** - An array of WorkspaceDto objects.

#### Error Responses
- **400** - Bad Request - Invalid inputs or request data
- **403** - Forbidden - Wrong API Key or access denied
- **404** - Not Found - Resource not found
- **429** - Too Many Requests - Rate limit exceeded or monthly API quota reached
```

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

### Get warmup tags

Source: https://api.hothawk.ai/docs/public-json

Retrieves a list of warmup tags associated with the specified workspace.

```APIDOC
## GET /v1/warmups/tags

### Description
Retrieves a list of warmup tags associated with the specified workspace.

### Method
GET

### Endpoint
/v1/warmups/tags

### Parameters
#### Query Parameters
- **workspaceId** (string) - Optional - The ID of the workspace from which to retrieve warmup tags. Example: "e8a0a56d-f9a2-4fa0-a4f9-3d00a051ed74"

### Response
#### Success Response (200)
- **array** - Items of type WarmupTagPublicDto
```

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

### Get All Webhooks

Source: https://api.hothawk.ai/docs/public-json

Fetches all webhooks for a specified workspace, with optional filtering by enabled status.

```APIDOC
## GET /v1/webhooks

### Description
Fetches all webhooks for the specified workspace.

### Method
GET

### Endpoint
/v1/webhooks

### Parameters
#### Query Parameters
- **workspaceId** (string) - Required - ID of the workspace to find webhooks for. Example: "e8a0a56d-f9a2-4fa0-a4f9-3d00a051ed74"
- **isEnabled** (boolean) - Optional - Filter by enabled status. Example: true

### Responses
#### Success Response (200)
- **array** (object) - Description: Success. Contains a list of WebhookDto objects.
  - **items** (object) - Schema referencing `#/components/schemas/WebhookDto`.

#### Error Responses
- **400** - Bad Request - Invalid inputs or request data
- **403** - Forbidden - Wrong API Key or access denied
- **404** - Not Found - Resource not found
- **429** - Too Many Requests - Rate limit exceeded or monthly API quota reached
```

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

### Get all labels

Source: https://api.hothawk.ai/docs/public-json

Fetches all labels for the given team based on the provided filters.

```APIDOC
## GET /v1/labels

### Description
Fetches all labels for the given team based on the provided filters.

### Method
GET

### Endpoint
/v1/labels

### Parameters
#### Query Parameters
- **workspaceId** (string) - Required - The ID of the workspace for which thread labels are being retrieved.
- **isClient** (boolean) - Optional

### Response
#### Success Response (200)
- (array of ThreadLabelDto) - Description not specified
```

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

### Get Workspace Client Settings

Source: https://api.hothawk.ai/docs/public-json

Retrieves client-specific settings for a given workspace, including label management, opportunities board, and email visibility.

```APIDOC
## GET /v1/workspaces/settings

### Description
Returns settings for label management, opportunities board, LinkedIn inbox, and email visibility.

### Method
GET

### Endpoint
/v1/workspaces/settings

### Query Parameters
- **workspaceId** (string) - Required - ID of the workspace to find client settings for

### Response
#### Success Response (200)
- **(object)** - Workspace client settings.
  - **labelManagement** (boolean) - Whether label management is enabled.
  - **opportunitiesBoard** (boolean) - Whether the opportunities board is enabled.
  - **linkedInInbox** (boolean) - Whether the LinkedIn inbox is enabled.
  - **emailVisibility** (string) - Email visibility setting ('all', 'none', 'specific').

#### Response Example
{
  "labelManagement": true,
  "opportunitiesBoard": false,
  "linkedInInbox": true,
  "emailVisibility": "all"
}
```

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

### Get Integration by Type

Source: https://api.hothawk.ai/docs/public-json

Fetches an integration by its type for the specified workspace. This allows retrieval of details for a specific integration configuration.

```APIDOC
## GET /v1/integrations/{type}

### Description
Fetches an integration by its type for the specified workspace.

### Method
GET

### Endpoint
/v1/integrations/{type}

### Parameters
#### Path Parameters
- **type** (string) - Required - The type of integration to find (EMAIL_BISON, HEY_REACH)
#### Query Parameters
- **workspaceId** (string) - Required

### Responses
#### Success Response (200)
- **IntegrationDto** - Details of the integration.

#### Error Responses
- **400** - Bad Request - Invalid inputs or request data
- **403** - Forbidden - Wrong API Key or access denied
- **404** - Not Found - Resource not found
- **429** - Too Many Requests - Rate limit exceeded or monthly API quota reached
```

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

### Get all thread reminders

Source: https://api.hothawk.ai/docs/public-json

Fetches all thread reminders based on the provided filters for the workspace.

```APIDOC
## GET /v1/reminders

### Description
Fetches all thread reminders based on the provided filters for the workspace.

### Method
GET

### Endpoint
/v1/reminders

### Parameters
#### Query Parameters
- **workspaceId** (string) - Optional - The ID of the workspace where the thread reminders belong.
- **threadId** (string) - Optional - The ID of the thread to fetch reminders for.

### Response
#### Success Response (200)
- **items** (array) - Array of ThreadReminderDto objects.

#### Response Example
{
  "example": "[ { \"id\": \"a1b2c3d4-e5f6-7890-1234-567890abcdef\", \"threadId\": \"d3f7a1bc-9c2e-4f1a-8b9c-1234567890ab\", \"remindAt\": \"2023-10-27T10:00:00Z\", \"createdAt\": \"2023-10-27T10:00:00Z\", \"updatedAt\": \"2023-10-27T10:00:00Z\" } ]"
}
```

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

### Get Webhook by ID

Source: https://api.hothawk.ai/docs/public-json

Fetches a specific webhook by its unique identifier.

```APIDOC
## GET /v1/webhooks/{id}

### Description
Fetches a specific webhook by its ID.

### Method
GET

### Endpoint
/v1/webhooks/{id}

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

### Responses
#### Success Response (200)
- **WebhookDto** (object) - Description: Success. The response contains the webhook details.

#### Error Responses
- **400** - Bad Request - Invalid inputs or request data
- **403** - Forbidden - Wrong API Key or access denied
- **404** - Not Found - Resource not found
- **429** - Too Many Requests - Rate limit exceeded or monthly API quota reached
```

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

### Find Stage Summaries

Source: https://api.hothawk.ai/docs/public-json

Get total value and count per stage for opportunities.

```APIDOC
## GET /v1/crm/opportunities/stage-summaries

### Description
Get total value and count per stage for opportunities.

### Method
GET

### Endpoint
/v1/crm/opportunities/stage-summaries

### Parameters
#### Query Parameters
- **workspaceId** (string) - Required - The unique identifier of the workspace.

### Response
#### Success Response (200)
- **body** (array) - An array of opportunity stage summaries.

#### Response Example
```json
{
  "example": "OpportunityStageSummaryDto[]"
}
```

#### Error Responses
- **400**: Bad Request - Invalid inputs or request data
- **403**: Forbidden - Wrong API Key or access denied
- **404**: Not Found - Resource not found
- **429**: Too Many Requests - Rate limit exceeded or monthly API quota reached
```

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

### Get Blocklist Entries

Source: https://api.hothawk.ai/docs/public-json

Retrieves a list of blocklist entries, with options for sorting.

```APIDOC
## GET /v1/blocklist

### Description
Retrieves a list of blocklist entries, with options for sorting.

### Method
GET

### Endpoint
/v1/blocklist

### Query Parameters
- **sort** (object) - Optional - Sorting parameters for the blocklist entries.
  - **field** (string) - Required - Field to sort by (value, source, type, addedByName, createdAt)
  - **order** (string) - Required - Sort order (ASC or DESC)
```

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

### Get all blocklist entries

Source: https://api.hothawk.ai/docs/public-json

Fetches all blocklist entries for the specified workspace, with options for pagination, searching, filtering, and sorting.

```APIDOC
## GET /v1/blocklist

### Description
Fetches all blocklist entries for the specified workspace.

### Method
GET

### Endpoint
/v1/blocklist

### Parameters
#### Query Parameters
- **page** (integer) - Required - The current page number to retrieve.
- **take** (integer) - Required - The number of records to retrieve per page, with a maximum of 150.
- **workspaceId** (string) - Required - Workspace ID
- **search** (string) - Optional - Search by email or domain
- **type** (string) - Optional - Filter by type (EMAIL, DOMAIN)
- **source** (string) - Optional - Filter by source (HOTHAWK, EMAIL_BISON, CLIENT_BOX)
- **sort** (array) - Optional - Sort criteria (e.g., `[{ "field": "createdAt", "order": "DESC" }]`)

### Response
#### Success Response (200)
- **data** (array) - Array of BlocklistEntryDto objects.

#### Response Example
{
  "example": "{\"data\": [{\"id\": \"some-id\", \"value\": \"example.com\", \"type\": \"DOMAIN\", \"source\": \"HOTHAWK\", \"createdAt\": \"2023-01-01T10:00:00Z\", \"addedByName\": \"Admin User\"}], \"total\": 1, \"page\": 1, \"take\": 25}"
}

#### Error Responses
- **400**: Bad Request - Invalid inputs or request data
- **403**: Forbidden - Wrong API Key or access denied
- **404**: Not Found - Resource not found
- **429**: Too Many Requests - Rate limit exceeded or monthly API quota reached
```

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

### Get opportunity stages

Source: https://api.hothawk.ai/docs/public-json

Retrieves a list of opportunity stages associated with the specified workspace.

```APIDOC
## GET /v1/crm/stages

### Description
Retrieves a list of opportunity stages associated with the specified workspace.

### Method
GET

### Endpoint
/v1/crm/stages

### Parameters
#### Query Parameters
- **workspaceId** (string) - Required - The ID of the workspace for which opportunity stages are being retrieved. Example: "a1b2c3d4-e5f6-7890-ab12-34567890cdef"

### Responses
#### Success Response (200)
- **Array of OpportunityStageDto** - A list of opportunity stages.

#### Error Responses
- **400** - Bad Request - Invalid inputs or request data
- **403** - Forbidden - Wrong API Key or access denied
- **404** - Not Found - Resource not found
- **429** - Too Many Requests - Rate limit exceeded or monthly API quota reached
```

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

### Find Opportunities

Source: https://api.hothawk.ai/docs/public-json

Get opportunities with pagination. Filter by workspace, email thread, LinkedIn conversation, or stage.

```APIDOC
## GET /v1/crm/opportunities

### Description
Get opportunities with pagination. Filter by workspace, email thread, LinkedIn conversation, or stage.

### Method
GET

### Endpoint
/v1/crm/opportunities

### Parameters
#### Query Parameters
- **workspaceId** (string) - Required - The unique identifier of the workspace where the opportunities are located. Example: "e8a0a56d-f9a2-4fa0-a4f9-3d00a051ed74"
- **threadId** (string) - Optional - Filter by email thread ID. Example: "8b2a8c40-7f4b-4f5a-9419-73a08b7d6f2e"
- **linkedinConversationId** (string) - Optional - Filter by LinkedIn conversation ID. Example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
- **stageId** (string) - Optional - Filter by opportunity stage ID. Example: "7c82c0a0-6d42-4a1c-8a52-64d99aef1a34"
- **page** (integer) - Optional - Page number for pagination. Minimum: 1. Default: 1. Example: 1
- **perStage** (integer) - Optional - Number of opportunities to load per stage. Minimum: 1. Maximum: 100. Default: 25. Example: 25

### Response
#### Success Response (200)
- **body** (object) - The paginated opportunities data.

#### Response Example
```json
{
  "example": "PaginatedOpportunitiesDto"
}
```

#### Error Responses
- **400**: Bad Request - Invalid inputs or request data
- **403**: Forbidden - Wrong API Key or access denied
- **404**: Not Found - Resource not found
- **429**: Too Many Requests - Rate limit exceeded or monthly API quota reached
```

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

### Get Subsequence Steps

Source: https://api.hothawk.ai/docs/public-json

Fetches all steps for a given subsequence, ordered by their position. Requires the subsequence ID.

```APIDOC
## GET /v1/subsequence-steps

### Description
Fetches all steps for the specified subsequence, ordered by their position.

### Method
GET

### Endpoint
/v1/subsequence-steps

### Query Parameters
- **sequenceId** (string) - Required - UUID of the sequence to filter sequence steps by. Example: `d7b7f89d-1aef-4414-9e68-d671b57a3b42`

### Response
#### Success Response (200)
- **array** - List of subsequence steps. Each item is a `SequenceStepDto` object.
```

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

### Get all threads

Source: https://api.hothawk.ai/docs/public-json

Fetches all threads based on the provided filters for the specified workspace. Supports pagination.

```APIDOC
## GET /v1/threads

### Description
Fetches all threads based on the provided filters for the specified workspace. Supports pagination.

### Method
GET

### Endpoint
/v1/threads

### Parameters
#### Query Parameters
- **page** (integer) - Required - The current page number to retrieve. Minimum: 1. Default: 1.
- **take** (integer) - Required - The number of records to retrieve per page, with a maximum of 150. Minimum: 1. Maximum: 150. Default: 25.
- **assignmentFilter** (string) - Optional - Filter threads by assignment status. Possible values: ALL_ASSIGNED, UNASSIGNED, USER (requires assignedUserId). Example: all_assigned.
- **assignedUserId** (string) - Optional - Filter by specific user ID. Required when assignmentFilter = USER. If omitted with USER filter, defaults to current user. Example: 550e8400-e29b-41d4-a716-446655440000.
- **workspaceId** (string) - Required - The ID of the workspace where the threads are located. Example: e8a0a56d-f9a2-4fa0-a4f9-3d00a051ed74.
- **seen** (boolean) - Optional - If true, only return threads that have been seen (read); if false, return only unseen (unread) threads. Example: true.
- **labelsIds** (array of strings) - Optional - An array of label IDs to filter threads by specific labels. If not provided, threads will not be filtered by labels. Example: ["labelId1","labelId2"].
- **folder** (string) - Required - The folder in which to search for threads. Possible values: INBOX, DONE, WARMUPS, DRAFT, SENT, TRASH, REMINDERS, SEQUENCES, HARD_BOUNCES, SOFT_BOUNCES. Example: INBOX.
- **hasLabels** (boolean) - Optional - Filter threads by label presence: set to `true` to fetch only threads with labels, or `false` to fetch only threads without labels. Example: false.

### Responses
#### Success Response (200)
- **PageInput** - Contains pagination information.
- **data** (array of ThreadInfoDto) - An array of thread information objects.

#### Error Responses
- **400** - Bad Request - Invalid inputs or request data
- **403** - Forbidden - Wrong API Key or access denied
- **404** - Not Found - Resource not found
- **429** - Too Many Requests - Rate limit exceeded or monthly API quota reached
```

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

### Get All Subsequences

Source: https://api.hothawk.ai/docs/public-json

Fetches all subsequences for the specified workspace. Supports filtering by status and draft state.

```APIDOC
## GET /v1/subsequences

### Description
Fetches all subsequences for the specified workspace. Supports filtering by status and draft state.

### Method
GET

### Endpoint
/v1/subsequences

### Parameters
#### Query Parameters
- **workspaceId** (string) - Required - UUID of the workspace to filter sequences by
- **status** (string) - Optional - Sequence status (enum: ["active", "paused", "pausing", "activating", "disabled"])
- **isDraft** (boolean) - Optional - Draft state filter

### Responses
#### Success Response (200)
- **description**: List of subsequences
- **content**: application/json
  - **schema**: array (items: #/components/schemas/SequenceDto)

#### Error Responses
- **400**: Bad Request - Invalid inputs or request data
- **403**: Forbidden - Wrong API Key or access denied
- **404**: Not Found - Resource not found
- **429**: Too Many Requests - Rate limit exceeded or monthly API quota reached
```

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

### Get All Events

Source: https://api.hothawk.ai/docs/public-json

Fetches all available webhook event types for a specified workspace. You can optionally filter events by category.

```APIDOC
## GET /v1/events

### Description
Fetches all available webhook event types for the specified workspace.

### Method
GET

### Endpoint
/v1/events

### Parameters
#### Query Parameters
- **workspaceId** (string) - Required - Workspace ID
- **category** (string) - Optional - Filters events by category (SYSTEM, LINKEDIN)

### Responses
#### Success Response (200)
- **array** - An array of EventPublicDto objects.

#### Error Responses
- **400** - Bad Request - Invalid inputs or request data
- **403** - Forbidden - Wrong API Key or access denied
- **404** - Not Found - Resource not found
- **429** - Too Many Requests - Rate limit exceeded or monthly API quota reached
```

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

### Get LinkedIn Tags

Source: https://api.hothawk.ai/docs/public-json

Get a list of LinkedIn tags for the specified workspace.

```APIDOC
## GET /v1/linkedin/tags

### Description
Get a list of LinkedIn tags for the specified workspace.

### Method
GET

### Endpoint
/v1/linkedin/tags

### Parameters
#### Query Parameters
- **workspaceId** (string) - Required - The workspace ID

### Response
#### Success Response (200)
- **id** (string) - Tag identifier.
- **name** (string) - Name of the tag.

#### Response Example
{
  "example": "{\"id\": \"tag_abc\", \"name\": \"Important\"}"
```

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

### Generate a client signup link

Source: https://api.hothawk.ai/docs/public-json

Creates an invite for a client and returns the signup link. The link uses the team's configured website URL.

```APIDOC
## POST /v1/team-member-invites/generate-client-signup-link

### Description
Creates an invite for a client and returns the signup link. The link uses the team's configured website URL.

### Method
POST

### Endpoint
/v1/team-member-invites/generate-client-signup-link

### Request Body
- **clientInvite** (object) - Required - The details for the client invite.
  - **email** (string) - Required - The email address of the client to invite.
  - **role** (string) - Required - The role to assign to the client (must be CLIENT).

### Request Example
```json
{
  "clientInvite": {
    "email": "client@example.com",
    "role": "CLIENT"
  }
}
```

### Response
#### Success Response (201)
- **signupLink** (string) - The generated signup link for the client.

#### Response Example
```json
{
  "signupLink": "https://your-team-website.com/signup?inviteId=xyz123"
}
```
```

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

### Create Lead

Source: https://api.hothawk.ai/docs/public-json

Creates a new lead.

```APIDOC
## POST /v1/crm/leads

### Description
Creates a new lead.

### Method
POST

### Endpoint
/v1/crm/leads

### Parameters
#### Request Body
- **CreateLeadPublicV1Input** - The input object for creating a lead.

### Response
#### Success Response (201)
- **LeadDto** - The created lead object.

#### Response Example
{
  "example": "{\"id\": \"lead_123\", \"name\": \"Jane Smith\", \"email\": \"jane.smith@example.com\"}"
}
```

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

### Create a new user invite

Source: https://api.hothawk.ai/docs/public-json

Creates a new invite for a user to join the workspace. Requires a request body containing the invite details.

```APIDOC
## POST /v1/team-member-invites

### Description
Creates a new invite for a user to join the workspace.

### Method
POST

### Endpoint
/v1/team-member-invites

### Request Body
- **invite** (object) - Required - The details of the user to invite.
  - **email** (string) - Required - The email address of the user to invite.
  - **role** (string) - Required - The role to assign to the invited user (e.g., TEAM_MEMBER, CLIENT).

### Request Example
```json
{
  "invite": {
    "email": "newuser@example.com",
    "role": "TEAM_MEMBER"
  }
}
```

### Response
#### Success Response (201)
- **invite** (object) - The created TeamMemberInviteDto object.

#### Response Example
```json
{
  "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "email": "newuser@example.com",
  "role": "TEAM_MEMBER",
  "isAccepted": false,
  "createdAt": "2023-10-27T11:00:00Z",
  "updatedAt": "2023-10-27T11:00:00Z"
}
```
```

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

### Get Event

Source: https://api.hothawk.ai/docs/public-json

Retrieves details of a specific event by its ID.

```APIDOC
## GET /events/{eventId}

### Description
Retrieves details of a specific event.

### Method
GET

### Endpoint
/events/{eventId}

### Parameters
#### Path Parameters
- **eventId** (string) - Required - The ID of the event to retrieve.

### Response
#### Success Response (200 OK)
- **id** (string) - Unique identifier of the event.
- **name** (string) - Display name of the event.
- **order** (number) - Sort order for displaying events.
- **type** (string) - Type of webhook event.
- **category** (string) - Category the event belongs to.
- **description** (string) - Detailed description of what triggers this event.
- **helpInfo** (string) - Additional help information for configuring this event.
- **requiredFields** (array) - Fields that must be provided when creating a webhook for this event.

#### Response Example
```json
{
  "id": "e8a0a56d-f9a2-4fa0-a4f9-3d00a051ed74",
  "name": "Specific Label Added",
  "order": 1,
  "type": "SPECIFIC_LABEL_ADDED",
  "category": "SYSTEM",
  "description": "Triggered when a specific label is added to a deal.",
  "helpInfo": "Select the label from the dropdown.",
  "requiredFields": ["labelId"]
}
```
```

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

### Create Workspace

Source: https://api.hothawk.ai/docs/public-json

Creates a new workspace. Requires a JSON payload with workspace details.

```APIDOC
## POST /v1/workspaces

### Description
Creates a new workspace.

### Method
POST

### Endpoint
/v1/workspaces

### Request Body
- **(object)** - Required - Workspace creation data.
  - **name** (string) - Required - The name of the workspace.
  - **description** (string) - Optional - A description for the workspace.

### Request Example
{
  "name": "My New Workspace",
  "description": "This is a test workspace"
}

### Response
#### Success Response (200)
- **(object)** - Details of the created workspace.
  - **id** (string) - The unique identifier of the workspace.
  - **name** (string) - The name of the workspace.
  - **description** (string) - The description of the workspace.
  - **createdAt** (string) - The date and time the workspace was created.

#### Response Example
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "My New Workspace",
  "description": "This is a test workspace",
  "createdAt": "2023-10-27T10:00:00Z"
}
```

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

### Get Webhook

Source: https://api.hothawk.ai/docs/public-json

Retrieves details of a specific webhook by its ID.

```APIDOC
## GET /webhooks/{webhookId}

### Description
Retrieves details of a specific webhook.

### Method
GET

### Endpoint
/webhooks/{webhookId}

### Parameters
#### Path Parameters
- **webhookId** (string) - Required - The ID of the webhook to retrieve.

### Response
#### Success Response (200 OK)
- **id** (string) - The unique identifier of the webhook.
- **name** (string) - The display name of the webhook.
- **destinationUrl** (string) - The URL where webhook payloads will be sent.
- **eventId** (string) - The ID of the event that triggers this webhook.
- **labelId** (string) - The ID of the label to filter events (if applicable).
- **tagId** (string) - The ID of the tag to filter events (if applicable).
- **memberId** (string) - The ID of the member to filter events (if applicable).
- **fromOpportunityStageId** (string) - The ID of the opportunity stage the deal is moving FROM.
- **toOpportunityStageId** (string) - The ID of the opportunity stage the deal is moving TO.
- **isEnabled** (boolean) - Whether this webhook is currently active.
- **createdAt** (string) - The date and time when the webhook was created.
- **updatedAt** (string) - The date and time when the webhook was last updated.

#### Response Example
```json
{
  "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "name": "New Lead Notification",
  "destinationUrl": "https://example.com/webhook",
  "eventId": "e8a0a56d-f9a2-4fa0-a4f9-3d00a051ed74",
  "labelId": null,
  "tagId": null,
  "memberId": null,
  "fromOpportunityStageId": null,
  "toOpportunityStageId": null,
  "isEnabled": true,
  "createdAt": "2023-10-27T10:00:00.000Z",
  "updatedAt": "2023-10-27T10:00:00.000Z"
}
```
```

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

### Warmup Tags

Source: https://api.hothawk.ai/docs/public

Manage warmup tags, including creation, bulk creation, and deletion.

```APIDOC
## GET /v1/warmups/tags

### Description
Get warmup tags

### Method
GET

### Endpoint
/v1/warmups/tags

## POST /v1/warmups/tags

### Description
Create a warmup tag

### Method
POST

### Endpoint
/v1/warmups/tags

## POST /v1/warmups/tags/bulk

### Description
Create multiple warmup tags

### Method
POST

### Endpoint
/v1/warmups/tags/bulk

## DELETE /v1/warmups/tags/{id}

### Description
Delete a warmup tag

### Method
DELETE

### Endpoint
/v1/warmups/tags/{id}
```

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

### Workspaces & ClientBox

Source: https://api.hothawk.ai/docs/public

Manage workspaces, including retrieval, creation, updates, and deletion.

```APIDOC
## GET /v1/workspaces

### Description
Get all workspaces

### Method
GET

### Endpoint
/v1/workspaces

## POST /v1/workspaces

### Description
Create a new workspace

### Method
POST

### Endpoint
/v1/workspaces

## GET /v1/workspaces/short

### Description
List workspace IDs and names

### Method
GET

### Endpoint
/v1/workspaces/short

## GET /v1/workspaces/analytics

### Description
Get workspace analytics summary

### Method
GET

### Endpoint
/v1/workspaces/analytics

## GET /v1/workspaces/settings

### Description
Get workspace client settings

### Method
GET

### Endpoint
/v1/workspaces/settings

## PATCH /v1/workspaces/settings/{workspaceId}

### Description
Update workspace client settings

### Method
PATCH

### Endpoint
/v1/workspaces/settings/{workspaceId}

## PATCH /v1/workspaces/{id}

### Description
Update a specific workspace

### Method
PATCH

### Endpoint
/v1/workspaces/{id}

## DELETE /v1/workspaces/{id}

### Description
Delete a workspace

### Method
DELETE

### Endpoint
/v1/workspaces/{id}
```

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

### Get LinkedIn Tags

Source: https://api.hothawk.ai/docs/public-json

Retrieves a list of available LinkedIn tags.

```APIDOC
## GET /v1/linkedin/tags

### Description
Retrieves a list of available LinkedIn tags.

### Method
GET

### Endpoint
/v1/linkedin/tags

### Responses
#### Success Response (200)
- items (array) - List of LinkedInTagDto objects

#### Response Example
```json
[
  {
    "id": "string",
    "name": "string",
    "type": "string"
  }
]
```

#### Error Responses
- 400: Bad Request - Invalid inputs or request data
- 403: Forbidden - Wrong API Key or access denied
- 404: Not Found - Resource not found
- 429: Too Many Requests - Rate limit exceeded or monthly API quota reached
```

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

### Create multiple warmup tags

Source: https://api.hothawk.ai/docs/public-json

Creates multiple warmup tags associated with the specified workspace.

```APIDOC
## POST /v1/warmups/tags/bulk

### Description
Creates multiple warmup tags associated with the specified workspace.

### Method
POST

### Endpoint
/v1/warmups/tags/bulk

### Request Body
- **CreateWarmupTagsCommonInput** - Required - Schema for creating multiple warmup tags

### Response
#### Success Response (200)
- **array** - Items of type WarmupTagPublicDto
```

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

### Create Sequence Steps

Source: https://api.hothawk.ai/docs/public-json

Adds new steps to an existing sequence.

```APIDOC
## POST /v1/sequences/steps

### Description
Adds new steps to an existing sequence.

### Method
POST

### Endpoint
/v1/sequences/steps

### Request Body
- **sequenceId** (string) - Required - ID of the sequence to add steps to
- **steps** (array) - Required - Steps to create. Each step must have `order`, `emailName`, and `emailContent`.
  - **order** (number) - Required - Order/position of this step in the sequence (1-based, must be unique)
  - **emailName** (string) - Required - Display name for this step
  - **emailContent** (string) - Required - Email body content with optional template variables
  - **delayValue** (number) - Optional - Delay value before sending (relative to previous step)
  - **delayUnit** (string) - Optional - Unit for delay (DAY, WEEK, MONTH)
  - **emailAttachments** (array) - Optional - Attachments for the email
```

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

### Get all custom variables

Source: https://api.hothawk.ai/docs/public-json

Fetches all custom variables based on the provided filters.

```APIDOC
## GET /v1/crm/custom-variables

### Description
Fetches all custom variables based on the provided filters.

### Method
GET

### Endpoint
/v1/crm/custom-variables

### Parameters
#### Query Parameters
- **assignedEntityType** (string) - Optional - Entity type this custom variable belongs to. Enum: ["lead", "company"]
- **workspaceId** (string) - Required - Workspace ID this custom variable belongs to. Format: uuid

### Response
#### Success Response (200)
- **items** (array) - Array of CustomVariableDto objects.

#### Response Example
{
  "example": "[ { \"id\": \"1f684e24-ef21-4544-a4a9-c994e2a6d2cf\", \"name\": \"Example Variable\", \"value\": \"Example Value\", \"assignedEntityType\": \"lead\", \"workspaceId\": \"b8a7a0be-dbe9-4e7b-b0f7-cf1c767b8a3c\", \"createdAt\": \"2023-10-27T10:00:00Z\", \"updatedAt\": \"2023-10-27T10:00:00Z\" } ]"
}
```

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

### Create Company

Source: https://api.hothawk.ai/docs/public-json

Creates a new company.

```APIDOC
## POST /v1/crm/companies

### Description
Create a new company.

### Method
POST

### Endpoint
/v1/crm/companies

### Request Body
- **name** (string) - Required - The name of the company.
- **workspaceId** (string) - Required - The workspace ID the company belongs to.

### Response
#### Success Response (201)
- **CompanyDto** (object) - The created company object.

#### Response Example
{
  "example": "{\"id\":\"company_123\",\"name\":\"Example Corp\",\"createdAt\":\"2023-01-01T10:00:00Z\",\"updatedAt\":\"2023-01-01T10:00:00Z\"}"
}
```

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

### Create Subsequence

Source: https://api.hothawk.ai/docs/public-json

Creates a new subsequence with specified configurations, including steps and scheduling.

```APIDOC
## POST /v1/subsequences

### Description
Creates a new subsequence. Ensure to provide a proper `timezone`, initial `steps` with `order`, and optionally `isDraft: true` for configuration before activation.

### Method
POST

### Endpoint
/v1/subsequences

### Request Body
- **body** (CreateSequencePublicV1Input) - Required - The input schema for creating a subsequence.

### Response
#### Success Response (201)
- **body** (SequenceDto) - Subsequence created successfully.

#### Error Responses
- **400**: Bad Request - Invalid inputs or request data.
- **403**: Forbidden - Wrong API Key or access denied.
- **404**: Not Found - Resource not found.
- **409**: Subsequence name already exists.
- **429**: Too Many Requests - Rate limit exceeded or monthly API quota reached.
```

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

### Get All Mailboxes

Source: https://api.hothawk.ai/docs/public-json

Retrieves a paginated list of mailboxes based on provided filters.

```APIDOC
## GET /v1/mailboxes

### Description
Retrieves a paginated list of mailboxes based on the provided filters.

### Method
GET

### Endpoint
/v1/mailboxes

### Parameters
#### Query Parameters
- **page** (integer) - Required - The current page number to retrieve. (default: 1, example: 1)
- **take** (integer) - Required - The number of records to retrieve per page, with a maximum of 150. (default: 25, example: 25)
- **workspaceId** (string) - Optional - The unique identifier (UUID) of the workspace to filter the mailboxes. (example: "c6b74d9e-4f4a-46e0-bb72-0b7d9d6f03bb")
- **email** (string) - Optional - Email address associated with the mailbox (example: "user@example.com")
- **currentConnectionStatus** (array of strings) - Optional - An array of connection statuses to filter by. (example: ["CONNECTED","GATHERING","DISCONNECTED"])

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

#### Response Example
```json
{
  "currentPage": 1,
  "take": 25,
  "itemCount": 100,
  "pageCount": 4,
  "data": [
    {
      "id": "string",
      "email": "string",
      "name": "string",
      "connectionStatus": "CONNECTED",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ]
}
```

#### Error Responses
- 400: Bad Request - Invalid inputs or request data
- 403: Forbidden - Wrong API Key or access denied
- 404: Not Found - Resource not found
- 429: Too Many Requests - Rate limit exceeded or monthly API quota reached
```

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

### Create a warmup tag

Source: https://api.hothawk.ai/docs/public-json

Creates a new warmup tag associated with the specified workspace.

```APIDOC
## POST /v1/warmups/tags

### Description
Creates a new warmup tag associated with the specified workspace.

### Method
POST

### Endpoint
/v1/warmups/tags

### Request Body
- **CreateWarmupTagCommonInput** - Required - Schema for creating a warmup tag

### Response
#### Success Response (200)
- **WarmupTagPublicDto** - Schema for a warmup tag object
```

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

### Get LinkedIn Conversation by ID

Source: https://api.hothawk.ai/docs/public-json

Fetches a specific LinkedIn conversation by its ID.

```APIDOC
## GET /v1/linkedin/conversations/{id}

### Description
Fetches a specific LinkedIn conversation by its ID.

### Method
GET

### Endpoint
/v1/linkedin/conversations/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Conversation identifier

### Response
#### Success Response (200)
- **id** (string) - Conversation identifier.
- **subject** (string) - Subject of the conversation.
- **lastMessage** (object) - The last message in the conversation.
- **createdAt** (string) - Timestamp when the conversation was created.

#### Response Example
{
  "example": "{\"id\": \"conv_123\", \"subject\": \"Meeting Follow-up\", \"lastMessage\": {\"text\": \"Hi John, thanks for the meeting!\", \"createdAt\": \"2023-10-27T10:00:00Z\"}, \"createdAt\": \"2023-10-26T09:00:00Z\"}"
```

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

### Create New Webhook

Source: https://api.hothawk.ai/docs/public-json

Creates a new webhook for the specified workspace.

```APIDOC
## POST /v1/webhooks

### Description
Creates a new webhook for the specified workspace.

### Method
POST

### Endpoint
/v1/webhooks

### Parameters
#### Request Body
- **required** (boolean) - Required - Indicates if the request body is required.
  - **content** (object) - Required - Specifies the content type and schema for the request body.
    - **application/json** (object) - Required - Defines the JSON content.
      - **schema** (object) - Required - The schema for the request body, referencing `#/components/schemas/CreateWebhookPublicV1Input`.

### Responses
#### Success Response (201)
- **WebhookDto** (object) - Description: Success. The response contains the newly created webhook details.

#### Error Responses
- **400** - Bad Request - Invalid inputs or request data
- **403** - Forbidden - Wrong API Key or access denied
- **404** - Not Found - Resource not found
- **429** - Too Many Requests - Rate limit exceeded or monthly API quota reached
```

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

### Get Blocklist Source Counts

Source: https://api.hothawk.ai/docs/public-json

Retrieves the counts of blocklist entries grouped by source.

```APIDOC
## GET /v1/blocklist/counts

### Description
Retrieves the counts of blocklist entries grouped by source.

### Method
GET

### Endpoint
/v1/blocklist/counts
```

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

### Get Subsequence by ID

Source: https://api.hothawk.ai/docs/public-json

Fetches a specific subsequence by its ID, including its configuration and statistics.

```APIDOC
## GET /v1/subsequences/{id}

### Description
Fetches a specific subsequence by its ID, including its configuration and statistics.

### Method
GET

### Endpoint
/v1/subsequences/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Subsequence UUID

### Response
#### Success Response (200)
- **body** (SequenceDto) - Subsequence details.

#### Error Responses
- **400**: Bad Request - Invalid inputs or request data.
- **403**: Forbidden - Wrong API Key or access denied.
- **404**: Not Found - Resource not found.
- **429**: Too Many Requests - Rate limit exceeded or monthly API quota reached.
```

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

### Create Integration

Source: https://api.hothawk.ai/docs/public-json

Creates a new integration for the specified workspace. Requires a request body containing the integration details.

```APIDOC
## POST /v1/integrations

### Description
Creates a new integration for the specified workspace.

### Method
POST

### Endpoint
/v1/integrations

### Request Body
- **CreateIntegrationInput** - Required - The input object for creating an integration.

### Responses
#### Success Response (201)
- **IntegrationDto** - Details of the newly created integration.

#### Error Responses
- **400** - Bad Request - Invalid inputs or request data
- **403** - Forbidden - Wrong API Key or access denied
- **404** - Not Found - Resource not found
- **429** - Too Many Requests - Rate limit exceeded or monthly API quota reached
```

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

### Get email message attachments

Source: https://api.hothawk.ai/docs/public-json

Fetches all attachments associated with the specified email message.

```APIDOC
## GET /v1/email-messages/{id}/attachments

### Description
Fetches all attachments associated with the specified email message.

### Method
GET

### Endpoint
/v1/email-messages/{id}/attachments

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the email message to retrieve attachments for.
```

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

### Create Opportunity

Source: https://api.hothawk.ai/docs/public-json

Create a new opportunity.

```APIDOC
## POST /v1/crm/opportunities

### Description
Create a new opportunity.

### Method
POST

### Endpoint
/v1/crm/opportunities

### Request Body
- **body** (object) - Required - The input object for creating an opportunity.

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

### Response
#### Success Response (201)
- **body** (object) - The created opportunity data.

#### Response Example
```json
{
  "example": "OpportunityDto"
}
```

#### Error Responses
- **400**: Bad Request - Invalid inputs or request data
- **403**: Forbidden - Wrong API Key or access denied
- **404**: Not Found - Resource not found
- **429**: Too Many Requests - Rate limit exceeded or monthly API quota reached
```