> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# freshdesk-companies

> Freshdesk Companies - Manage companies, custom objects, and company fields

**Server path:** `/freshdesk-companies` | **Type:** Application | **PCID required:** Yes

## Tools

| Tool                                                                                                  | Description                   |
| ----------------------------------------------------------------------------------------------------- | ----------------------------- |
| [`freshdesk_companies_create_company`](#freshdesk_companies_create_company)                           | Create a company              |
| [`freshdesk_companies_create_custom_object_record`](#freshdesk_companies_create_custom_object_record) | Create a custom object record |
| [`freshdesk_companies_delete_company`](#freshdesk_companies_delete_company)                           | Delete a company              |
| [`freshdesk_companies_delete_custom_object_record`](#freshdesk_companies_delete_custom_object_record) | Delete a custom object record |
| [`freshdesk_companies_export_companies`](#freshdesk_companies_export_companies)                       | Export companies              |
| [`freshdesk_companies_get_company`](#freshdesk_companies_get_company)                                 | Get a company                 |
| [`freshdesk_companies_get_custom_object_record`](#freshdesk_companies_get_custom_object_record)       | Get a custom object record    |
| [`freshdesk_companies_get_custom_object_schema`](#freshdesk_companies_get_custom_object_schema)       | Get a custom object schema    |
| [`freshdesk_companies_list_companies`](#freshdesk_companies_list_companies)                           | List all companies            |
| [`freshdesk_companies_list_company_fields`](#freshdesk_companies_list_company_fields)                 | List all company fields       |
| [`freshdesk_companies_list_custom_object_records`](#freshdesk_companies_list_custom_object_records)   | List custom object records    |
| [`freshdesk_companies_list_custom_object_schemas`](#freshdesk_companies_list_custom_object_schemas)   | List custom object schemas    |
| [`freshdesk_companies_search_companies`](#freshdesk_companies_search_companies)                       | Search companies              |
| [`freshdesk_companies_update_company`](#freshdesk_companies_update_company)                           | Update a company              |
| [`freshdesk_companies_update_custom_object_record`](#freshdesk_companies_update_custom_object_record) | Update a custom object record |

***

## freshdesk\_companies\_create\_company

Create a company

**Parameters:**

| Parameter       | Type      | Required | Default | Description                  |
| --------------- | --------- | -------- | ------- | ---------------------------- |
| `account_tier`  | string    | No       | —       | Account tier                 |
| `custom_fields` | object    | No       | —       | Custom field key-value pairs |
| `description`   | string    | No       | —       | The description value        |
| `domains`       | string\[] | No       | —       | Email domains to associate   |
| `health_score`  | string    | No       | —       | Health score                 |
| `industry`      | string    | No       | —       | The industry value           |
| `name`          | string    | Yes      | —       | Name of the company          |
| `note`          | string    | No       | —       | Notes                        |
| `renewal_date`  | string    | No       | —       | Renewal date                 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "account_tier": {
        "type": "string",
        "description": "Account tier"
      },
      "custom_fields": {
        "type": "object",
        "description": "Custom field key-value pairs"
      },
      "description": {
        "type": "string",
        "description": "The description value"
      },
      "domains": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "Email domains to associate"
      },
      "health_score": {
        "type": "string",
        "description": "Health score"
      },
      "industry": {
        "type": "string",
        "description": "The industry value"
      },
      "name": {
        "type": "string",
        "description": "Name of the company"
      },
      "note": {
        "type": "string",
        "description": "Notes"
      },
      "renewal_date": {
        "type": "string",
        "description": "Renewal date"
      }
    },
    "required": [
      "PCID",
      "name"
    ]
  }
  ```
</Expandable>

***

## freshdesk\_companies\_create\_custom\_object\_record

Create a custom object record

**Parameters:**

| Parameter   | Type   | Required | Default | Description                                    |
| ----------- | ------ | -------- | ------- | ---------------------------------------------- |
| `schema_id` | string | Yes      | —       | ID of the custom object schema                 |
| `data`      | object | Yes      | —       | Key-value pairs of field values for the record |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "schema_id": {
        "type": "string",
        "description": "ID of the custom object schema"
      },
      "data": {
        "type": "object",
        "description": "Key-value pairs of field values for the record"
      }
    },
    "required": [
      "PCID",
      "schema_id",
      "data"
    ]
  }
  ```
</Expandable>

***

## freshdesk\_companies\_delete\_company

Delete a company

**Parameters:**

| Parameter | Type    | Required | Default | Description                 |
| --------- | ------- | -------- | ------- | --------------------------- |
| `id`      | integer | Yes      | —       | ID of the company to delete |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "ID of the company to delete"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## freshdesk\_companies\_delete\_custom\_object\_record

Delete a custom object record

**Parameters:**

| Parameter   | Type   | Required | Default | Description                    |
| ----------- | ------ | -------- | ------- | ------------------------------ |
| `schema_id` | string | Yes      | —       | ID of the custom object schema |
| `record_id` | string | Yes      | —       | ID of the custom object record |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "schema_id": {
        "type": "string",
        "description": "ID of the custom object schema"
      },
      "record_id": {
        "type": "string",
        "description": "ID of the custom object record"
      }
    },
    "required": [
      "PCID",
      "schema_id",
      "record_id"
    ]
  }
  ```
</Expandable>

***

## freshdesk\_companies\_export\_companies

Export companies

**Parameters:**

| Parameter        | Type   | Required | Default | Description                                     |
| ---------------- | ------ | -------- | ------- | ----------------------------------------------- |
| `custom_fields`  | object | No       | —       | Custom company fields to include in the export  |
| `default_fields` | object | No       | —       | Default company fields to include in the export |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "custom_fields": {
        "type": "object",
        "description": "Custom company fields to include in the export"
      },
      "default_fields": {
        "type": "object",
        "description": "Default company fields to include in the export"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## freshdesk\_companies\_get\_company

Get a company

**Parameters:**

| Parameter | Type    | Required | Default | Description       |
| --------- | ------- | -------- | ------- | ----------------- |
| `id`      | integer | Yes      | —       | ID of the company |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "ID of the company"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## freshdesk\_companies\_get\_custom\_object\_record

Get a custom object record

**Parameters:**

| Parameter   | Type   | Required | Default | Description                    |
| ----------- | ------ | -------- | ------- | ------------------------------ |
| `schema_id` | string | Yes      | —       | ID of the custom object schema |
| `record_id` | string | Yes      | —       | ID of the custom object record |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "schema_id": {
        "type": "string",
        "description": "ID of the custom object schema"
      },
      "record_id": {
        "type": "string",
        "description": "ID of the custom object record"
      }
    },
    "required": [
      "PCID",
      "schema_id",
      "record_id"
    ]
  }
  ```
</Expandable>

***

## freshdesk\_companies\_get\_custom\_object\_schema

Get a custom object schema

**Parameters:**

| Parameter   | Type   | Required | Default | Description                    |
| ----------- | ------ | -------- | ------- | ------------------------------ |
| `schema_id` | string | Yes      | —       | ID of the custom object schema |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "schema_id": {
        "type": "string",
        "description": "ID of the custom object schema"
      }
    },
    "required": [
      "PCID",
      "schema_id"
    ]
  }
  ```
</Expandable>

***

## freshdesk\_companies\_list\_companies

List all companies

**Parameters:**

| Parameter  | Type    | Required | Default | Description                          |
| ---------- | ------- | -------- | ------- | ------------------------------------ |
| `page`     | integer | No       | —       | Page number for pagination           |
| `per_page` | integer | No       | —       | Number of results per page (max 100) |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "page": {
        "type": "integer",
        "description": "Page number for pagination"
      },
      "per_page": {
        "type": "integer",
        "description": "Number of results per page (max 100)"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## freshdesk\_companies\_list\_company\_fields

List all company fields

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## freshdesk\_companies\_list\_custom\_object\_records

List custom object records

**Parameters:**

| Parameter   | Type    | Required | Default | Description                              |
| ----------- | ------- | -------- | ------- | ---------------------------------------- |
| `schema_id` | string  | Yes      | —       | ID of the custom object schema           |
| `page`      | integer | No       | —       | Page number for pagination (starts at 1) |
| `per_page`  | integer | No       | —       | Number of results per page (max 100)     |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "schema_id": {
        "type": "string",
        "description": "ID of the custom object schema"
      },
      "page": {
        "type": "integer",
        "description": "Page number for pagination (starts at 1)"
      },
      "per_page": {
        "type": "integer",
        "description": "Number of results per page (max 100)"
      }
    },
    "required": [
      "PCID",
      "schema_id"
    ]
  }
  ```
</Expandable>

***

## freshdesk\_companies\_list\_custom\_object\_schemas

List custom object schemas

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## freshdesk\_companies\_search\_companies

Search companies

**Parameters:**

| Parameter | Type    | Required | Default | Description                                                                                                                                                                             |
| --------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `query`   | string  | Yes      | —       | Search query using Freshdesk query language. The value MUST be enclosed in double quotes, e.g. "status:2 AND priority:3". Without the surrounding quotes, the API will return an error. |
| `page`    | integer | No       | —       | Page number for pagination                                                                                                                                                              |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "query": {
        "type": "string",
        "description": "Search query using Freshdesk query language. The value MUST be enclosed in double quotes, e.g. \"status:2 AND priority:3\". Without the surrounding quotes, the API will return an error."
      },
      "page": {
        "type": "integer",
        "description": "Page number for pagination"
      }
    },
    "required": [
      "PCID",
      "query"
    ]
  }
  ```
</Expandable>

***

## freshdesk\_companies\_update\_company

Update a company

**Parameters:**

| Parameter       | Type      | Required | Default | Description                  |
| --------------- | --------- | -------- | ------- | ---------------------------- |
| `id`            | integer   | Yes      | —       | ID of the company to update  |
| `account_tier`  | string    | No       | —       | Account tier                 |
| `custom_fields` | object    | No       | —       | Custom field key-value pairs |
| `description`   | string    | No       | —       | The description value        |
| `domains`       | string\[] | No       | —       | Email domains                |
| `health_score`  | string    | No       | —       | Health score                 |
| `industry`      | string    | No       | —       | The industry value           |
| `name`          | string    | No       | —       | Name of the company          |
| `note`          | string    | No       | —       | Notes                        |
| `renewal_date`  | string    | No       | —       | Renewal date                 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "ID of the company to update"
      },
      "account_tier": {
        "type": "string",
        "description": "Account tier"
      },
      "custom_fields": {
        "type": "object",
        "description": "Custom field key-value pairs"
      },
      "description": {
        "type": "string",
        "description": "The description value"
      },
      "domains": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "Email domains"
      },
      "health_score": {
        "type": "string",
        "description": "Health score"
      },
      "industry": {
        "type": "string",
        "description": "The industry value"
      },
      "name": {
        "type": "string",
        "description": "Name of the company"
      },
      "note": {
        "type": "string",
        "description": "Notes"
      },
      "renewal_date": {
        "type": "string",
        "description": "Renewal date"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## freshdesk\_companies\_update\_custom\_object\_record

Update a custom object record

**Parameters:**

| Parameter   | Type   | Required | Default | Description                               |
| ----------- | ------ | -------- | ------- | ----------------------------------------- |
| `schema_id` | string | Yes      | —       | ID of the custom object schema            |
| `record_id` | string | Yes      | —       | ID of the custom object record            |
| `data`      | object | No       | —       | Key-value pairs of field values to update |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "schema_id": {
        "type": "string",
        "description": "ID of the custom object schema"
      },
      "record_id": {
        "type": "string",
        "description": "ID of the custom object record"
      },
      "data": {
        "type": "object",
        "description": "Key-value pairs of field values to update"
      }
    },
    "required": [
      "PCID",
      "schema_id",
      "record_id"
    ]
  }
  ```
</Expandable>