> ## 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. # cats-companies > CATS Companies - manage companies, departments, phones, and custom fields **Server path:** `/cats-companies` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | ----------------------------------------------------------------------------------------------------- | -------------------------------- | | [`cats_companies_add_department`](#cats_companies_add_department) | Add department | | [`cats_companies_attach_company_tags`](#cats_companies_attach_company_tags) | Attach company tags | | [`cats_companies_change_a_company_thumbnail`](#cats_companies_change_a_company_thumbnail) | Change a company thumbnail | | [`cats_companies_change_company_status`](#cats_companies_change_company_status) | Change company status | | [`cats_companies_create_a_company`](#cats_companies_create_a_company) | Create a company | | [`cats_companies_create_a_company_list`](#cats_companies_create_a_company_list) | Create a company list | | [`cats_companies_create_a_company_phone`](#cats_companies_create_a_company_phone) | Create a company phone | | [`cats_companies_create_company_list_items`](#cats_companies_create_company_list_items) | Create company list items | | [`cats_companies_delete_a_company`](#cats_companies_delete_a_company) | Delete a company | | [`cats_companies_delete_a_company_list`](#cats_companies_delete_a_company_list) | Delete a company list | | [`cats_companies_delete_a_company_list_item`](#cats_companies_delete_a_company_list_item) | Delete a company list item | | [`cats_companies_delete_a_company_phone`](#cats_companies_delete_a_company_phone) | Delete a company phone | | [`cats_companies_delete_company_tag`](#cats_companies_delete_company_tag) | Delete company tag | | [`cats_companies_delete_department`](#cats_companies_delete_department) | Delete department | | [`cats_companies_filter_companies`](#cats_companies_filter_companies) | Filter companies | | [`cats_companies_get_a_company`](#cats_companies_get_a_company) | Get a company | | [`cats_companies_get_a_company_custom_field`](#cats_companies_get_a_company_custom_field) | Get a company custom field | | [`cats_companies_get_a_company_custom_field_value`](#cats_companies_get_a_company_custom_field_value) | Get a company custom field value | | [`cats_companies_get_a_company_list_item`](#cats_companies_get_a_company_list_item) | Get a company list item | | [`cats_companies_get_a_company_phone`](#cats_companies_get_a_company_phone) | Get a company phone | | [`cats_companies_get_a_company_status`](#cats_companies_get_a_company_status) | Get a company status | | [`cats_companies_get_a_company_thumbnail`](#cats_companies_get_a_company_thumbnail) | Get a company thumbnail | | [`cats_companies_get_a_department`](#cats_companies_get_a_department) | Get a department | | [`cats_companies_get_a_list`](#cats_companies_get_a_list) | Get a list | | [`cats_companies_list_all_companies`](#cats_companies_list_all_companies) | List all companies | | [`cats_companies_list_all_company_list_items`](#cats_companies_list_all_company_list_items) | List all company list items | | [`cats_companies_list_all_company_lists`](#cats_companies_list_all_company_lists) | List all company lists | | [`cats_companies_list_all_company_tags`](#cats_companies_list_all_company_tags) | List all company tags | | [`cats_companies_list_all_departments`](#cats_companies_list_all_departments) | List all departments | | [`cats_companies_list_company_attachments`](#cats_companies_list_company_attachments) | List company attachments | | [`cats_companies_list_company_custom_field_values`](#cats_companies_list_company_custom_field_values) | List company custom field values | | [`cats_companies_list_company_custom_fields`](#cats_companies_list_company_custom_fields) | List company custom fields | | [`cats_companies_list_company_phones`](#cats_companies_list_company_phones) | List company phones | | [`cats_companies_list_company_statuses`](#cats_companies_list_company_statuses) | List company statuses | | [`cats_companies_list_company_tasks`](#cats_companies_list_company_tasks) | List company tasks | | [`cats_companies_replace_company_tags`](#cats_companies_replace_company_tags) | Replace company tags | | [`cats_companies_search_companies`](#cats_companies_search_companies) | Search companies | | [`cats_companies_update_a_company`](#cats_companies_update_a_company) | Update a company | | [`cats_companies_update_a_company_custom_field`](#cats_companies_update_a_company_custom_field) | Update a company custom field | | [`cats_companies_update_a_company_phone`](#cats_companies_update_a_company_phone) | Update a company phone | | [`cats_companies_update_department`](#cats_companies_update_department) | Update department | | [`cats_companies_upload_a_company_attachment`](#cats_companies_upload_a_company_attachment) | Upload a company attachment | *** ## cats\_companies\_add\_department Add department **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ------------------------------------------- | | `company_id` | number | Yes | — | The ID of the company to add department on. | | `name` | string | Yes | — | The name value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "company_id": { "type": "number", "description": "The ID of the company to add department on." }, "name": { "type": "string", "description": "The name value" } }, "required": [ "PCID", "company_id", "name" ] } ``` *** ## cats\_companies\_attach\_company\_tags Attach company tags **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ---------------------------------------- | | `company_id` | number | Yes | — | The ID of the company to attach tags to. | | `tags` | any\[] | No | — | The tags value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "company_id": { "type": "number", "description": "The ID of the company to attach tags to." }, "tags": { "type": "array", "description": "The tags value" } }, "required": [ "PCID", "company_id" ] } ``` *** ## cats\_companies\_change\_a\_company\_thumbnail Change a company thumbnail **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------- | | `id` | number | Yes | — | The ID of the company to change the thumbnail of. | | `_links` | object | No | — | The links value | | `attachment_id` | number | No | — | Only required if source is set to `attachment` (must be an attachment belonging to the data item)## Trigger (object) | | `description` | string | No | — | The description value | | `is_default` | boolean | No | — | Is Default | | `is_required` | boolean | No | — | Is Required | | `source` | string | No | — | One of `attachment`, `clearbit`, or `disabled`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "number", "description": "The ID of the company to change the thumbnail of." }, "_links": { "type": "object", "description": "The links value" }, "attachment_id": { "type": "number", "description": "Only required if source is set to `attachment` (must be an attachment belonging to the data item)## Trigger (object)" }, "description": { "type": "string", "description": "The description value" }, "is_default": { "type": "boolean", "description": "Is Default" }, "is_required": { "type": "boolean", "description": "Is Required" }, "source": { "type": "string", "description": "One of `attachment`, `clearbit`, or `disabled`." } }, "required": [ "PCID", "id" ] } ``` *** ## cats\_companies\_change\_company\_status Change company status **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | number | Yes | — | The ID of the company that the status is being attached to. | | `status_id` | number | Yes | — | The ID of the status to attach. | | `triggers` | any\[] | No | — | An array of objects each containing the ID of an attached trigger and a boolean representing whether or not to fire the trigger. If the `triggers` parameter is not set, all required triggers will be fired as well as all triggers that are marked as optional and on by default. Optional triggers that are off by default will not fire. If the `triggers` parameter is specified, *all* triggers that are attached to the status must be included in the array and the API will make no assumptions about which triggers to fire. Example: `[ { "id": <trigger ID>, "fire": <boolean> } ]` | ````json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "number", "description": "The ID of the company that the status is being attached to." }, "status_id": { "type": "number", "description": "The ID of the status to attach." }, "triggers": { "type": "array", "description": "An array of objects each containing the ID of an attached trigger and a boolean representing whether or not to fire the trigger. If the `triggers` parameter is not set, all required triggers will be fired as well as all triggers that are marked as optional and on by default. Optional triggers that are off by default will not fire. If the `triggers` parameter is specified, *all* triggers that are attached to the status must be included in the array and the API will make no assumptions about which triggers to fire. Example: ``` [ { \"id\": , \"fire\": } ] ```" } }, "required": [ "PCID", "id", "status_id" ] } ```` *** ## cats\_companies\_create\_a\_company Create a company **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `check_duplicate` | boolean | Yes | — | When this flag is set to true, if a duplicate record is found to the one being created, an error will be thrown instead of creating a duplicate record. Defaults to false. | | `address` | object | No | — | An object containing the address for the company with the following structure: `{ "street": "<street>", "city": "<city>", "state": "<state>", "postal_code": "<postal code>" }` | | `billing_contact_id` | number | No | — | Billing Contact Id | | `country_code` | string | No | — | Country Code | | `custom_fields` | any\[] | No | — | An array of custom field objects. Each custom field object should contain two keys: `id` and `value`. `id` is the id of a custom field definition, and `value` is the value to be set to that custom field for this company. `[ { "id": <custom field definition id>, "value": "<custom field value>" } ]` | | `entered_by_id` | number | No | — | Entered By Id | | `is_hot` | boolean | No | — | Is Hot | | `key_technologies` | string | No | — | Key Technologies | | `name` | string | Yes | — | The name value | | `notes` | string | No | — | The notes value | | `owner_id` | number | Yes | — | Owner Id | | `phones` | any\[] | No | — | An array of phone objects. Each phone object should contain three keys: `number`, `extension`, and `type`, as described here `[ { "number": <phone number with country code>, "extension": "<optional extension>", "type": "<phone number type>", } ]` | | `social_media_urls` | any\[] | No | — | Social Media Urls | | `user_groups` | any\[] | No | — | User groups allowed to access this company | | `website` | string | No | — | The website value | ````json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "check_duplicate": { "type": "boolean", "description": "When this flag is set to true, if a duplicate record is found to the one being created, an error will be thrown instead of creating a duplicate record. Defaults to false." }, "address": { "type": "object", "description": "An object containing the address for the company with the following structure: ``` { \"street\": \"\", \"city\": \"\", \"state\": \"\", \"postal_code\": \"\" } ```", "properties": { "street": { "type": "string", "description": "The street value" }, "city": { "type": "string", "description": "The city value" }, "state": { "type": "string", "description": "The state value" }, "postal_code": { "type": "string", "description": "Postal Code" } } }, "billing_contact_id": { "type": "number", "description": "Billing Contact Id" }, "country_code": { "type": "string", "description": "Country Code" }, "custom_fields": { "type": "array", "description": "An array of custom field objects. Each custom field object should contain two keys: `id` and `value`. `id` is the id of a custom field definition, and `value` is the value to be set to that custom field for this company. ``` [ { \"id\": , \"value\": \"\" } ] ```" }, "entered_by_id": { "type": "number", "description": "Entered By Id" }, "is_hot": { "type": "boolean", "description": "Is Hot" }, "key_technologies": { "type": "string", "description": "Key Technologies" }, "name": { "type": "string", "description": "The name value" }, "notes": { "type": "string", "description": "The notes value" }, "owner_id": { "type": "number", "description": "Owner Id" }, "phones": { "type": "array", "description": "An array of phone objects. Each phone object should contain three keys: `number`, `extension`, and `type`, as described [here](#companies-create-a-phone) ``` [ { \"number\": , \"extension\": \"\", \"type\": \"\", } ] ```" }, "social_media_urls": { "type": "array", "description": "Social Media Urls" }, "user_groups": { "type": "array", "description": "User groups allowed to access this company" }, "website": { "type": "string", "description": "The website value" } }, "required": [ "PCID", "check_duplicate", "name", "owner_id" ] } ```` *** ## cats\_companies\_create\_a\_company\_list Create a company list **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | --------------- | | `name` | string | Yes | — | The name value | | `notes` | string | No | — | The notes value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "The name value" }, "notes": { "type": "string", "description": "The notes value" } }, "required": [ "PCID", "name" ] } ``` *** ## cats\_companies\_create\_a\_company\_phone Create a company phone **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ---------------------------------------------------------------------------------------- | | `company_id` | number | Yes | — | The company to create the phone for. | | `extension` | string | No | — | The extension value | | `number` | string | Yes | — | This number MUST begin with the country code. It will not be parsed correctly otherwise. | | `type` | string | Yes | — | One of `fax`, `main`, or `other`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "company_id": { "type": "number", "description": "The company to create the phone for." }, "extension": { "type": "string", "description": "The extension value" }, "number": { "type": "string", "description": "This number MUST begin with the country code. It will not be parsed correctly otherwise." }, "type": { "type": "string", "description": "One of `fax`, `main`, or `other`." } }, "required": [ "PCID", "company_id", "number", "type" ] } ``` *** ## cats\_companies\_create\_company\_list\_items Create company list items **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | --------------------------- | | `id` | number | Yes | — | The ID of the company list. | | `items` | any\[] | No | — | The items value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "number", "description": "The ID of the company list." }, "items": { "type": "array", "description": "The items value" } }, "required": [ "PCID", "id" ] } ``` *** ## cats\_companies\_delete\_a\_company Delete a company **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | -------------------------------- | | `id` | number | Yes | — | The ID of the company to delete. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "number", "description": "The ID of the company to delete." } }, "required": [ "PCID", "id" ] } ``` *** ## cats\_companies\_delete\_a\_company\_list Delete a company list **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------------------- | | `id` | number | Yes | — | The ID of the company list to delete. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "number", "description": "The ID of the company list to delete." } }, "required": [ "PCID", "id" ] } ``` *** ## cats\_companies\_delete\_a\_company\_list\_item Delete a company list item **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ---------------------------------- | | `list_id` | number | Yes | — | The ID of the company list. | | `item_id` | number | Yes | — | The ID of the list item to delete. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "list_id": { "type": "number", "description": "The ID of the company list." }, "item_id": { "type": "number", "description": "The ID of the list item to delete." } }, "required": [ "PCID", "list_id", "item_id" ] } ``` *** ## cats\_companies\_delete\_a\_company\_phone Delete a company phone **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ------------------------------------- | | `company_id` | number | Yes | — | The company to delete the phone from. | | `id` | number | Yes | — | The ID of the phone to delete. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "company_id": { "type": "number", "description": "The company to delete the phone from." }, "id": { "type": "number", "description": "The ID of the phone to delete." } }, "required": [ "PCID", "company_id", "id" ] } ``` *** ## cats\_companies\_delete\_company\_tag Delete company tag **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | --------------------------------------------- | | `company_id` | number | Yes | — | The ID of the company to detach the tag from. | | `tag_id` | number | Yes | — | The ID of the tag to detach. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "company_id": { "type": "number", "description": "The ID of the company to detach the tag from." }, "tag_id": { "type": "number", "description": "The ID of the tag to detach." } }, "required": [ "PCID", "company_id", "tag_id" ] } ``` *** ## cats\_companies\_delete\_department Delete department **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------ | -------- | ------- | ----------------------------------- | | `department_id` | number | Yes | — | The ID of the department to delete. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "department_id": { "type": "number", "description": "The ID of the department to delete." } }, "required": [ "PCID", "department_id" ] } ``` *** ## cats\_companies\_filter\_companies Filter companies **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `query` | string | Yes | — | The optional string to search within companies for. | | `page` | number | Yes | — | The current page number of companies to return. | | `per_page` | number | Yes | — | The number of companies to return per page. | | `field` | string | Yes | — | The field to filter on. See the above list to determine which fields can be filtered. | | `filter` | string | Yes | — | The filter to use. See the above list to determine which fields allow what filters. | | `value` | string | Yes | — | The value to filter by. Different filters take different value types (string, array, int). See the section in the introduction to see what values each filter accepts. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "query": { "type": "string", "description": "The optional string to search within companies for." }, "page": { "type": "number", "description": "The current page number of companies to return." }, "per_page": { "type": "number", "description": "The number of companies to return per page." }, "field": { "type": "string", "description": "The field to filter on. See the above list to determine which fields can be filtered." }, "filter": { "type": "string", "description": "The filter to use. See the above list to determine which fields allow what filters." }, "value": { "type": "string", "description": "The value to filter by. Different filters take different value types (string, array, int). See the section in the introduction to see what values each filter accepts." } }, "required": [ "PCID", "query", "page", "per_page", "field", "filter", "value" ] } ``` *** ## cats\_companies\_get\_a\_company Get a company **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | -------------------------------- | | `id` | number | Yes | — | The ID of the company to return. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "number", "description": "The ID of the company to return." } }, "required": [ "PCID", "id" ] } ``` *** ## cats\_companies\_get\_a\_company\_custom\_field Get a company custom field **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------------------------------ | | `id` | number | Yes | — | The ID of the custom field definition to return. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "number", "description": "The ID of the custom field definition to return." } }, "required": [ "PCID", "id" ] } ``` *** ## cats\_companies\_get\_a\_company\_custom\_field\_value Get a company custom field value **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ------------------------------------------------------- | | `company_id` | number | Yes | — | The ID of the company that the custom field belongs to. | | `custom_field_id` | number | Yes | — | The ID of the custom field to return. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "company_id": { "type": "number", "description": "The ID of the company that the custom field belongs to." }, "custom_field_id": { "type": "number", "description": "The ID of the custom field to return." } }, "required": [ "PCID", "company_id", "custom_field_id" ] } ``` *** ## cats\_companies\_get\_a\_company\_list\_item Get a company list item **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ----------------------------------------------- | | `list_id` | number | Yes | — | The ID of the company list the item belongs to. | | `item_id` | number | Yes | — | The ID of the company list item to return. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "list_id": { "type": "number", "description": "The ID of the company list the item belongs to." }, "item_id": { "type": "number", "description": "The ID of the company list item to return." } }, "required": [ "PCID", "list_id", "item_id" ] } ``` *** ## cats\_companies\_get\_a\_company\_phone Get a company phone **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ------------------------------------ | | `company_id` | number | Yes | — | The company to return the phone for. | | `id` | number | Yes | — | The ID of the phone to return. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "company_id": { "type": "number", "description": "The company to return the phone for." }, "id": { "type": "number", "description": "The ID of the phone to return." } }, "required": [ "PCID", "company_id", "id" ] } ``` *** ## cats\_companies\_get\_a\_company\_status Get a company status **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------------- | | `id` | number | Yes | — | The ID of the status to return. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "number", "description": "The ID of the status to return." } }, "required": [ "PCID", "id" ] } ``` *** ## cats\_companies\_get\_a\_company\_thumbnail Get a company thumbnail **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ---------------------------------------------- | | `id` | number | Yes | — | The ID of the company to get the thumbnail of. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "number", "description": "The ID of the company to get the thumbnail of." } }, "required": [ "PCID", "id" ] } ``` *** ## cats\_companies\_get\_a\_department Get a department **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ----------------------------------- | | `id` | number | Yes | — | The ID of the department to return. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "number", "description": "The ID of the department to return." } }, "required": [ "PCID", "id" ] } ``` *** ## cats\_companies\_get\_a\_list Get a list **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------------------- | | `id` | number | Yes | — | The ID of the company list to return. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "number", "description": "The ID of the company list to return." } }, "required": [ "PCID", "id" ] } ``` *** ## cats\_companies\_list\_all\_companies List all companies **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ----------------------------------------------- | | `page` | number | Yes | — | The current page number of companies to return. | | `per_page` | number | Yes | — | The number of companies to return per page. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "number", "description": "The current page number of companies to return." }, "per_page": { "type": "number", "description": "The number of companies to return per page." } }, "required": [ "PCID", "page", "per_page" ] } ``` *** ## cats\_companies\_list\_all\_company\_list\_items List all company list items **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------------------------------------ | | `id` | number | Yes | — | The ID of the company list to return items for. | | `page` | number | Yes | — | The current page number of list items to return. | | `per_page` | number | Yes | — | The number of list items to return per page. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "number", "description": "The ID of the company list to return items for." }, "page": { "type": "number", "description": "The current page number of list items to return." }, "per_page": { "type": "number", "description": "The number of list items to return per page." } }, "required": [ "PCID", "id", "page", "per_page" ] } ``` *** ## cats\_companies\_list\_all\_company\_lists List all company lists **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------------------------------- | | `page` | number | Yes | — | The current page number of lists to return. | | `per_page` | number | Yes | — | The number of lists to return per page. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "number", "description": "The current page number of lists to return." }, "per_page": { "type": "number", "description": "The number of lists to return per page." } }, "required": [ "PCID", "page", "per_page" ] } ``` *** ## cats\_companies\_list\_all\_company\_tags List all company tags **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ------------------------------------------ | | `company_id` | number | Yes | — | The ID of the company to return tags for. | | `page` | number | Yes | — | The current page number of tags to return. | | `per_page` | number | Yes | — | The number of tags to return per page. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "company_id": { "type": "number", "description": "The ID of the company to return tags for." }, "page": { "type": "number", "description": "The current page number of tags to return." }, "per_page": { "type": "number", "description": "The number of tags to return per page." } }, "required": [ "PCID", "company_id", "page", "per_page" ] } ``` *** ## cats\_companies\_list\_all\_departments List all departments **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ------------------------------------------------- | | `company_id` | number | Yes | — | The ID of the company to return departments for. | | `page` | number | Yes | — | The current page number of departments to return. | | `per_page` | number | Yes | — | The number of departments to return per page. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "company_id": { "type": "number", "description": "The ID of the company to return departments for." }, "page": { "type": "number", "description": "The current page number of departments to return." }, "per_page": { "type": "number", "description": "The number of departments to return per page." } }, "required": [ "PCID", "company_id", "page", "per_page" ] } ``` *** ## cats\_companies\_list\_company\_attachments List company attachments **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------------------------------------- | | `id` | number | Yes | — | The ID of the company to return attachments for. | | `page` | number | Yes | — | The current page number of attachments to return. | | `per_page` | number | Yes | — | The number of attachments to return per page. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "number", "description": "The ID of the company to return attachments for." }, "page": { "type": "number", "description": "The current page number of attachments to return." }, "per_page": { "type": "number", "description": "The number of attachments to return per page." } }, "required": [ "PCID", "id", "page", "per_page" ] } ``` *** ## cats\_companies\_list\_company\_custom\_field\_values List company custom field values **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | --------------------------------------------------- | | `id` | number | Yes | — | The ID of the company to return custom fields for. | | `page` | number | Yes | — | The current page number of custom fields to return. | | `per_page` | number | Yes | — | The number of custom fields to return per page. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "number", "description": "The ID of the company to return custom fields for." }, "page": { "type": "number", "description": "The current page number of custom fields to return." }, "per_page": { "type": "number", "description": "The number of custom fields to return per page." } }, "required": [ "PCID", "id", "page", "per_page" ] } ``` *** ## cats\_companies\_list\_company\_custom\_fields List company custom fields **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | -------------------------------------------------------------- | | `page` | number | Yes | — | The current page number of custom field definitions to return. | | `per_page` | number | Yes | — | The number of custom field definitions to return per page. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "number", "description": "The current page number of custom field definitions to return." }, "per_page": { "type": "number", "description": "The number of custom field definitions to return per page." } }, "required": [ "PCID", "page", "per_page" ] } ``` *** ## cats\_companies\_list\_company\_phones List company phones **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | -------------------------------------------- | | `company_id` | number | Yes | — | The company to return phones for. | | `page` | number | Yes | — | The current page number of phones to return. | | `per_page` | number | Yes | — | The number of phones to return per page. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "company_id": { "type": "number", "description": "The company to return phones for." }, "page": { "type": "number", "description": "The current page number of phones to return." }, "per_page": { "type": "number", "description": "The number of phones to return per page." } }, "required": [ "PCID", "company_id", "page", "per_page" ] } ``` *** ## cats\_companies\_list\_company\_statuses List company statuses **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ---------------------------------------------- | | `page` | number | Yes | — | The current page number of statuses to return. | | `per_page` | number | Yes | — | The number of statuses to return per page. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "number", "description": "The current page number of statuses to return." }, "per_page": { "type": "number", "description": "The number of statuses to return per page." } }, "required": [ "PCID", "page", "per_page" ] } ``` *** ## cats\_companies\_list\_company\_tasks List company tasks **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------------------------------------ | | `id` | number | Yes | — | The ID of the company to fetch tasks concerning. | | `page` | number | Yes | — | The current page number of tasks to return. | | `per_page` | number | Yes | — | The number of task items to return per page. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "number", "description": "The ID of the company to fetch tasks concerning." }, "page": { "type": "number", "description": "The current page number of tasks to return." }, "per_page": { "type": "number", "description": "The number of task items to return per page." } }, "required": [ "PCID", "id", "page", "per_page" ] } ``` *** ## cats\_companies\_replace\_company\_tags Replace company tags **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ----------------------------------------- | | `company_id` | number | Yes | — | The ID of the company to replace tags on. | | `tags` | any\[] | No | — | The tags value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "company_id": { "type": "number", "description": "The ID of the company to replace tags on." }, "tags": { "type": "array", "description": "The tags value" } }, "required": [ "PCID", "company_id" ] } ``` *** ## cats\_companies\_search\_companies Search companies **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ----------------------------------------------- | | `query` | string | Yes | — | The string to search within companies for. | | `page` | number | Yes | — | The current page number of companies to return. | | `per_page` | number | Yes | — | The number of companies to return per page. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "query": { "type": "string", "description": "The string to search within companies for." }, "page": { "type": "number", "description": "The current page number of companies to return." }, "per_page": { "type": "number", "description": "The number of companies to return per page." } }, "required": [ "PCID", "query", "page", "per_page" ] } ``` *** ## cats\_companies\_update\_a\_company Update a company **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | number | Yes | — | The ID of the company to update. | | `address` | object | No | — | An object containing the address for the company with the following structure: `{ "street": "<street>", "city": "<city>", "state": "<state>", "postal_code": "<postal code>" }` | | `billing_contact_id` | number | No | — | Billing Contact Id | | `country_code` | string | No | — | Country Code | | `custom_fields` | any\[] | No | — | An array of custom field objects. Each custom field object should contain two keys: `id` and `value`. `id` is the id of a custom field definition, and `value` is the value to be set to that custom field for this company. `[ { "id": <custom field definition id>, "value": "<custom field value>" } ]` | | `entered_by_id` | number | No | — | Entered By Id | | `is_hot` | boolean | No | — | Is Hot | | `key_technologies` | string | No | — | Key Technologies | | `name` | string | No | — | The name value | | `notes` | string | No | — | The notes value | | `owner_id` | number | No | — | Owner Id | | `phones` | any\[] | No | — | An array of phone objects. Each phone object should contain three keys: `number`, `extension`, and `type`, as described here `[ { "number": <phone number with country code>, "extension": "<optional extension>", "type": "<phone number type>", } ]` | | `social_media_urls` | any\[] | No | — | Social Media Urls | | `user_groups` | any\[] | No | — | User groups allowed to access this company | | `website` | string | No | — | The website value | ````json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "number", "description": "The ID of the company to update." }, "address": { "type": "object", "description": "An object containing the address for the company with the following structure: ``` { \"street\": \"\", \"city\": \"\", \"state\": \"\", \"postal_code\": \"\" } ```", "properties": { "street": { "type": "string", "description": "The street value" }, "city": { "type": "string", "description": "The city value" }, "state": { "type": "string", "description": "The state value" }, "postal_code": { "type": "string", "description": "Postal Code" } } }, "billing_contact_id": { "type": "number", "description": "Billing Contact Id" }, "country_code": { "type": "string", "description": "Country Code" }, "custom_fields": { "type": "array", "description": "An array of custom field objects. Each custom field object should contain two keys: `id` and `value`. `id` is the id of a custom field definition, and `value` is the value to be set to that custom field for this company. ``` [ { \"id\": , \"value\": \"\" } ] ```" }, "entered_by_id": { "type": "number", "description": "Entered By Id" }, "is_hot": { "type": "boolean", "description": "Is Hot" }, "key_technologies": { "type": "string", "description": "Key Technologies" }, "name": { "type": "string", "description": "The name value" }, "notes": { "type": "string", "description": "The notes value" }, "owner_id": { "type": "number", "description": "Owner Id" }, "phones": { "type": "array", "description": "An array of phone objects. Each phone object should contain three keys: `number`, `extension`, and `type`, as described [here](#companies-create-a-phone) ``` [ { \"number\": , \"extension\": \"\", \"type\": \"\", } ] ```" }, "social_media_urls": { "type": "array", "description": "Social Media Urls" }, "user_groups": { "type": "array", "description": "User groups allowed to access this company" }, "website": { "type": "string", "description": "The website value" } }, "required": [ "PCID", "id" ] } ```` *** ## cats\_companies\_update\_a\_company\_custom\_field Update a company custom field **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ------------------------------------------------------- | | `company_id` | number | Yes | — | The ID of the company that the custom field belongs to. | | `custom_field_id` | number | Yes | — | The ID of the custom field to update. | | `value` | string | No | — | The value value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "company_id": { "type": "number", "description": "The ID of the company that the custom field belongs to." }, "custom_field_id": { "type": "number", "description": "The ID of the custom field to update." }, "value": { "type": "string", "description": "The value value" } }, "required": [ "PCID", "company_id", "custom_field_id" ] } ``` *** ## cats\_companies\_update\_a\_company\_phone Update a company phone **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ---------------------------------------------------------------------------------------- | | `company_id` | number | Yes | — | The company to update the phone for. | | `id` | number | Yes | — | The ID of the phone to update. | | `extension` | string | No | — | The extension value | | `number` | string | No | — | This number MUST begin with the country code. It will not be parsed correctly otherwise. | | `type` | string | No | — | One of `fax`, `main`, or `other`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "company_id": { "type": "number", "description": "The company to update the phone for." }, "id": { "type": "number", "description": "The ID of the phone to update." }, "extension": { "type": "string", "description": "The extension value" }, "number": { "type": "string", "description": "This number MUST begin with the country code. It will not be parsed correctly otherwise." }, "type": { "type": "string", "description": "One of `fax`, `main`, or `other`." } }, "required": [ "PCID", "company_id", "id" ] } ``` *** ## cats\_companies\_update\_department Update department **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------ | -------- | ------- | ----------------------------------- | | `department_id` | number | Yes | — | The ID of the department to update. | | `name` | string | No | — | The name value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "department_id": { "type": "number", "description": "The ID of the department to update." }, "name": { "type": "string", "description": "The name value" } }, "required": [ "PCID", "department_id" ] } ``` *** ## cats\_companies\_upload\_a\_company\_attachment Upload a company attachment **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | --------------------------------------------------------------- | | `id` | number | Yes | — | The ID of the company that the attachment is being attached to. | | `filename` | string | Yes | — | The name to save the file being uploaded as. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "number", "description": "The ID of the company that the attachment is being attached to." }, "filename": { "type": "string", "description": "The name to save the file being uploaded as." } }, "required": [ "PCID", "id", "filename" ] } ```