> ## 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.

# repairshopr-customers

> RepairShopr Customers - manage customers, contacts, leads, and portal users

**Server path:** `/repairshopr-customers` | **Type:** Application | **PCID required:** Yes

## Tools

| Tool                                                                                                                          | Description                                                  |
| ----------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ |
| [`repairshopr_customers_create_contacts`](#repairshopr_customers_create_contacts)                                             | Creates a Contact                                            |
| [`repairshopr_customers_create_customers`](#repairshopr_customers_create_customers)                                           | Creates a Customer                                           |
| [`repairshopr_customers_create_leads`](#repairshopr_customers_create_leads)                                                   | Creates a Lead                                               |
| [`repairshopr_customers_create_portal_users`](#repairshopr_customers_create_portal_users)                                     | Creates a Portal User                                        |
| [`repairshopr_customers_create_portal_users_create_invitation`](#repairshopr_customers_create_portal_users_create_invitation) | Creates an Invitation for a Portal User                      |
| [`repairshopr_customers_delete_by_id`](#repairshopr_customers_delete_by_id)                                                   | Deletes a Customer by ID                                     |
| [`repairshopr_customers_delete_contacts_by_id`](#repairshopr_customers_delete_contacts_by_id)                                 | Deletes a Contact                                            |
| [`repairshopr_customers_delete_portal_users_by_id`](#repairshopr_customers_delete_portal_users_by_id)                         | Deletes a Portal User by ID                                  |
| [`repairshopr_customers_get_by_id`](#repairshopr_customers_get_by_id)                                                         | Retrieves a Customer by ID                                   |
| [`repairshopr_customers_get_contacts_by_id`](#repairshopr_customers_get_contacts_by_id)                                       | Retrieves a Contact by ID                                    |
| [`repairshopr_customers_get_leads_by_id`](#repairshopr_customers_get_leads_by_id)                                             | Retrieves a Lead by ID                                       |
| [`repairshopr_customers_list_contacts`](#repairshopr_customers_list_contacts)                                                 | Returns a paginated list of Contacts                         |
| [`repairshopr_customers_list_customers`](#repairshopr_customers_list_customers)                                               | Returns a paginated list of customers                        |
| [`repairshopr_customers_list_customers_autocomplete`](#repairshopr_customers_list_customers_autocomplete)                     | Returns a paginated list of customers for autocomplete query |
| [`repairshopr_customers_list_customers_latest`](#repairshopr_customers_list_customers_latest)                                 | Returns latest Customer                                      |
| [`repairshopr_customers_list_leads`](#repairshopr_customers_list_leads)                                                       | Returns a paginated list of Leads                            |
| [`repairshopr_customers_list_portal_users`](#repairshopr_customers_list_portal_users)                                         | Returns a paginated list of Portal Users                     |
| [`repairshopr_customers_list_search`](#repairshopr_customers_list_search)                                                     | Search all the things                                        |
| [`repairshopr_customers_update_contacts_by_id`](#repairshopr_customers_update_contacts_by_id)                                 | Updates an existing Contact                                  |
| [`repairshopr_customers_update_customers_by_id`](#repairshopr_customers_update_customers_by_id)                               | Updates an existing Customer by ID                           |
| [`repairshopr_customers_update_leads_by_id`](#repairshopr_customers_update_leads_by_id)                                       | Updates an existing Lead by ID                               |
| [`repairshopr_customers_update_portal_users_by_id`](#repairshopr_customers_update_portal_users_by_id)                         | Updates an existing Portal User by ID                        |

***

## repairshopr\_customers\_create\_contacts

Creates a Contact

**Parameters:**

| Parameter     | Type    | Required | Default | Description        |
| ------------- | ------- | -------- | ------- | ------------------ |
| `address1`    | string  | No       | —       | The address1 value |
| `address2`    | string  | No       | —       | The address2 value |
| `city`        | string  | No       | —       | The city value     |
| `customer_id` | integer | Yes      | —       | Customer Id        |
| `email`       | string  | No       | —       | The email value    |
| `mobile`      | string  | No       | —       | The mobile value   |
| `name`        | string  | No       | —       | The name value     |
| `notes`       | string  | No       | —       | The notes value    |
| `phone`       | string  | No       | —       | The phone value    |
| `state`       | string  | No       | —       | The state value    |
| `zip`         | string  | No       | —       | The zip value      |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "address1": {
        "type": "string",
        "description": "The address1 value"
      },
      "address2": {
        "type": "string",
        "description": "The address2 value"
      },
      "city": {
        "type": "string",
        "description": "The city value"
      },
      "customer_id": {
        "type": "integer",
        "description": "Customer Id"
      },
      "email": {
        "type": "string",
        "description": "The email value"
      },
      "mobile": {
        "type": "string",
        "description": "The mobile value"
      },
      "name": {
        "type": "string",
        "description": "The name value"
      },
      "notes": {
        "type": "string",
        "description": "The notes value"
      },
      "phone": {
        "type": "string",
        "description": "The phone value"
      },
      "state": {
        "type": "string",
        "description": "The state value"
      },
      "zip": {
        "type": "string",
        "description": "The zip value"
      }
    },
    "required": [
      "PCID",
      "customer_id"
    ]
  }
  ```
</Expandable>

***

## repairshopr\_customers\_create\_customers

Creates a Customer

**Parameters:**

| Parameter            | Type    | Required | Default | Description          |
| -------------------- | ------- | -------- | ------- | -------------------- |
| `address`            | string  | No       | —       | The address value    |
| `address_2`          | string  | No       | —       | Address 2            |
| `business_name`      | string  | No       | —       | Business Name        |
| `city`               | string  | No       | —       | The city value       |
| `consent`            | object  | No       | —       | The consent value    |
| `email`              | string  | No       | —       | The email value      |
| `firstname`          | string  | No       | —       | The firstname value  |
| `get_billing`        | boolean | No       | —       | Get Billing          |
| `get_marketing`      | boolean | No       | —       | Get Marketing        |
| `get_reports`        | boolean | No       | —       | Get Reports          |
| `get_sms`            | boolean | No       | —       | Get Sms              |
| `invoice_cc_emails`  | string  | No       | —       | Invoice Cc Emails    |
| `invoice_term_id`    | integer | No       | —       | Invoice Term Id      |
| `lastname`           | string  | No       | —       | The lastname value   |
| `mobile`             | string  | No       | —       | The mobile value     |
| `no_email`           | boolean | No       | —       | No Email             |
| `notes`              | string  | No       | —       | The notes value      |
| `notification_email` | string  | No       | —       | Notification Email   |
| `opt_out`            | boolean | No       | —       | Opt Out              |
| `phone`              | string  | No       | —       | The phone value      |
| `properties`         | object  | No       | —       | The properties value |
| `ref_customer_id`    | integer | No       | —       | Ref Customer Id      |
| `referred_by`        | string  | No       | —       | Referred By          |
| `state`              | string  | No       | —       | The state value      |
| `tax_rate_id`        | integer | No       | —       | Tax Rate Id          |
| `zip`                | string  | No       | —       | The zip value        |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "address": {
        "type": "string",
        "description": "The address value"
      },
      "address_2": {
        "type": "string",
        "description": "Address 2"
      },
      "business_name": {
        "type": "string",
        "description": "Business Name"
      },
      "city": {
        "type": "string",
        "description": "The city value"
      },
      "consent": {
        "type": "object",
        "description": "The consent value"
      },
      "email": {
        "type": "string",
        "description": "The email value"
      },
      "firstname": {
        "type": "string",
        "description": "The firstname value"
      },
      "get_billing": {
        "type": "boolean",
        "description": "Get Billing"
      },
      "get_marketing": {
        "type": "boolean",
        "description": "Get Marketing"
      },
      "get_reports": {
        "type": "boolean",
        "description": "Get Reports"
      },
      "get_sms": {
        "type": "boolean",
        "description": "Get Sms"
      },
      "invoice_cc_emails": {
        "type": "string",
        "description": "Invoice Cc Emails"
      },
      "invoice_term_id": {
        "type": "integer",
        "description": "Invoice Term Id"
      },
      "lastname": {
        "type": "string",
        "description": "The lastname value"
      },
      "mobile": {
        "type": "string",
        "description": "The mobile value"
      },
      "no_email": {
        "type": "boolean",
        "description": "No Email"
      },
      "notes": {
        "type": "string",
        "description": "The notes value"
      },
      "notification_email": {
        "type": "string",
        "description": "Notification Email"
      },
      "opt_out": {
        "type": "boolean",
        "description": "Opt Out"
      },
      "phone": {
        "type": "string",
        "description": "The phone value"
      },
      "properties": {
        "type": "object",
        "description": "The properties value"
      },
      "ref_customer_id": {
        "type": "integer",
        "description": "Ref Customer Id"
      },
      "referred_by": {
        "type": "string",
        "description": "Referred By"
      },
      "state": {
        "type": "string",
        "description": "The state value"
      },
      "tax_rate_id": {
        "type": "integer",
        "description": "Tax Rate Id"
      },
      "zip": {
        "type": "string",
        "description": "The zip value"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## repairshopr\_customers\_create\_leads

Creates a Lead

**Parameters:**

| Parameter                    | Type    | Required | Default | Description                |
| ---------------------------- | ------- | -------- | ------- | -------------------------- |
| `address`                    | string  | No       | —       | The address value          |
| `appointment_time`           | string  | No       | —       | Appointment Time           |
| `appointment_type_id`        | integer | No       | —       | Appointment Type Id        |
| `business_name`              | string  | No       | —       | Business Name              |
| `city`                       | string  | No       | —       | The city value             |
| `contact_id`                 | integer | No       | —       | Contact Id                 |
| `converted`                  | boolean | No       | —       | The converted value        |
| `customer_id`                | integer | No       | —       | Customer Id                |
| `customer_purchase_id`       | integer | No       | —       | Customer Purchase Id       |
| `disabled`                   | boolean | No       | —       | The disabled value         |
| `email`                      | string  | No       | —       | The email value            |
| `first_name`                 | string  | No       | —       | First Name                 |
| `from_check_in`              | boolean | No       | —       | From Check In              |
| `hidden_notes`               | string  | No       | —       | Hidden Notes               |
| `last_name`                  | string  | No       | —       | Last Name                  |
| `likelihood`                 | integer | No       | —       | The likelihood value       |
| `location_id`                | integer | No       | —       | Location Id                |
| `mailbox_id`                 | integer | No       | —       | Mailbox Id                 |
| `message_read`               | boolean | No       | —       | Message Read               |
| `mobile`                     | string  | No       | —       | The mobile value           |
| `opportunity_amount_dollars` | number  | No       | —       | Opportunity Amount Dollars |
| `opportunity_start_date`     | string  | No       | —       | Opportunity Start Date     |
| `phone`                      | string  | No       | —       | The phone value            |
| `properties`                 | object  | No       | —       | The properties value       |
| `signature_data`             | string  | No       | —       | Signature Data             |
| `signature_date`             | string  | No       | —       | Signature Date             |
| `signature_name`             | string  | No       | —       | Signature Name             |
| `state`                      | string  | No       | —       | The state value            |
| `status`                     | string  | No       | —       | The status value           |
| `ticket_description`         | string  | No       | —       | Ticket Description         |
| `ticket_id`                  | integer | No       | —       | Ticket Id                  |
| `ticket_problem_type`        | string  | No       | —       | Ticket Problem Type        |
| `ticket_properties`          | object  | No       | —       | Ticket Properties          |
| `ticket_subject`             | string  | No       | —       | Ticket Subject             |
| `ticket_type_id`             | integer | No       | —       | Ticket Type Id             |
| `user_id`                    | integer | No       | —       | User Id                    |
| `zip`                        | string  | No       | —       | The zip value              |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "address": {
        "type": "string",
        "description": "The address value"
      },
      "appointment_time": {
        "type": "string",
        "description": "Appointment Time"
      },
      "appointment_type_id": {
        "type": "integer",
        "description": "Appointment Type Id"
      },
      "business_name": {
        "type": "string",
        "description": "Business Name"
      },
      "city": {
        "type": "string",
        "description": "The city value"
      },
      "contact_id": {
        "type": "integer",
        "description": "Contact Id"
      },
      "converted": {
        "type": "boolean",
        "description": "The converted value"
      },
      "customer_id": {
        "type": "integer",
        "description": "Customer Id"
      },
      "customer_purchase_id": {
        "type": "integer",
        "description": "Customer Purchase Id"
      },
      "disabled": {
        "type": "boolean",
        "description": "The disabled value"
      },
      "email": {
        "type": "string",
        "description": "The email value"
      },
      "first_name": {
        "type": "string",
        "description": "First Name"
      },
      "from_check_in": {
        "type": "boolean",
        "description": "From Check In"
      },
      "hidden_notes": {
        "type": "string",
        "description": "Hidden Notes"
      },
      "last_name": {
        "type": "string",
        "description": "Last Name"
      },
      "likelihood": {
        "type": "integer",
        "description": "The likelihood value"
      },
      "location_id": {
        "type": "integer",
        "description": "Location Id"
      },
      "mailbox_id": {
        "type": "integer",
        "description": "Mailbox Id"
      },
      "message_read": {
        "type": "boolean",
        "description": "Message Read"
      },
      "mobile": {
        "type": "string",
        "description": "The mobile value"
      },
      "opportunity_amount_dollars": {
        "type": "number",
        "description": "Opportunity Amount Dollars"
      },
      "opportunity_start_date": {
        "type": "string",
        "description": "Opportunity Start Date"
      },
      "phone": {
        "type": "string",
        "description": "The phone value"
      },
      "properties": {
        "type": "object",
        "description": "The properties value"
      },
      "signature_data": {
        "type": "string",
        "description": "Signature Data"
      },
      "signature_date": {
        "type": "string",
        "description": "Signature Date"
      },
      "signature_name": {
        "type": "string",
        "description": "Signature Name"
      },
      "state": {
        "type": "string",
        "description": "The state value"
      },
      "status": {
        "type": "string",
        "description": "The status value"
      },
      "ticket_description": {
        "type": "string",
        "description": "Ticket Description"
      },
      "ticket_id": {
        "type": "integer",
        "description": "Ticket Id"
      },
      "ticket_problem_type": {
        "type": "string",
        "description": "Ticket Problem Type"
      },
      "ticket_properties": {
        "type": "object",
        "description": "Ticket Properties"
      },
      "ticket_subject": {
        "type": "string",
        "description": "Ticket Subject"
      },
      "ticket_type_id": {
        "type": "integer",
        "description": "Ticket Type Id"
      },
      "user_id": {
        "type": "integer",
        "description": "User Id"
      },
      "zip": {
        "type": "string",
        "description": "The zip value"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## repairshopr\_customers\_create\_portal\_users

Creates a Portal User

**Parameters:**

| Parameter               | Type    | Required | Default | Description           |
| ----------------------- | ------- | -------- | ------- | --------------------- |
| `contact_id`            | integer | No       | —       | Contact Id            |
| `customer_id`           | integer | No       | —       | Customer Id           |
| `email`                 | string  | No       | —       | The email value       |
| `password`              | string  | No       | —       | The password value    |
| `password_confirmation` | string  | No       | —       | Password Confirmation |
| `portal_group_id`       | integer | No       | —       | Portal Group Id       |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "contact_id": {
        "type": "integer",
        "description": "Contact Id"
      },
      "customer_id": {
        "type": "integer",
        "description": "Customer Id"
      },
      "email": {
        "type": "string",
        "description": "The email value"
      },
      "password": {
        "type": "string",
        "description": "The password value"
      },
      "password_confirmation": {
        "type": "string",
        "description": "Password Confirmation"
      },
      "portal_group_id": {
        "type": "integer",
        "description": "Portal Group Id"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## repairshopr\_customers\_create\_portal\_users\_create\_invitation

Creates an Invitation for a Portal User

**Parameters:**

| Parameter | Type    | Required | Default | Description  |
| --------- | ------- | -------- | ------- | ------------ |
| `id`      | integer | Yes      | —       | The id value |

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

***

## repairshopr\_customers\_delete\_by\_id

Deletes a Customer by ID

**Parameters:**

| Parameter | Type    | Required | Default | Description  |
| --------- | ------- | -------- | ------- | ------------ |
| `id`      | integer | Yes      | —       | The id value |

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

***

## repairshopr\_customers\_delete\_contacts\_by\_id

Deletes a Contact

**Parameters:**

| Parameter | Type    | Required | Default | Description  |
| --------- | ------- | -------- | ------- | ------------ |
| `id`      | integer | Yes      | —       | The id value |

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

***

## repairshopr\_customers\_delete\_portal\_users\_by\_id

Deletes a Portal User by ID

**Parameters:**

| Parameter | Type    | Required | Default | Description  |
| --------- | ------- | -------- | ------- | ------------ |
| `id`      | integer | Yes      | —       | The id value |

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

***

## repairshopr\_customers\_get\_by\_id

Retrieves a Customer by ID

**Parameters:**

| Parameter | Type    | Required | Default | Description  |
| --------- | ------- | -------- | ------- | ------------ |
| `id`      | integer | Yes      | —       | The id value |

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

***

## repairshopr\_customers\_get\_contacts\_by\_id

Retrieves a Contact by ID

**Parameters:**

| Parameter | Type    | Required | Default | Description  |
| --------- | ------- | -------- | ------- | ------------ |
| `id`      | integer | Yes      | —       | The id value |

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

***

## repairshopr\_customers\_get\_leads\_by\_id

Retrieves a Lead by ID

**Parameters:**

| Parameter | Type    | Required | Default | Description  |
| --------- | ------- | -------- | ------- | ------------ |
| `id`      | integer | Yes      | —       | The id value |

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

***

## repairshopr\_customers\_list\_contacts

Returns a paginated list of Contacts

**Parameters:**

| Parameter     | Type    | Required | Default | Description                                                       |
| ------------- | ------- | -------- | ------- | ----------------------------------------------------------------- |
| `customer_id` | integer | No       | —       | Any contacts attached to a Customer ID                            |
| `page`        | integer | No       | —       | Returns provided page of results, each 'page' contains 25 results |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "customer_id": {
        "type": "integer",
        "description": "Any contacts attached to a Customer ID"
      },
      "page": {
        "type": "integer",
        "description": "Returns provided page of results, each 'page' contains 25 results"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## repairshopr\_customers\_list\_customers

Returns a paginated list of customers

**Parameters:**

| Parameter          | Type       | Required | Default | Description                                                               |
| ------------------ | ---------- | -------- | ------- | ------------------------------------------------------------------------- |
| `sort`             | string     | No       | —       | A customer field to order by. Examples "firstname ASC", "city DESC".      |
| `query`            | string     | No       | —       | Search query                                                              |
| `firstname`        | string     | No       | —       | Any customers with a first name like the parameter                        |
| `lastname`         | string     | No       | —       | Any customers with a last name like the parameter                         |
| `business_name`    | string     | No       | —       | Any customers with a business name like the parameter                     |
| `id`               | integer\[] | No       | —       | Any customers with ID included in the list                                |
| `not_id`           | integer\[] | No       | —       | Any customers with ID not included in the list                            |
| `email`            | string     | No       | —       | The email value                                                           |
| `include_disabled` | string     | No       | —       | Whether or not the returned list of customers includes disabled customers |
| `page`             | integer    | No       | —       | Returns provided page of results, each 'page' contains 25 results         |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "sort": {
        "type": "string",
        "description": "A customer field to order by. Examples \"firstname ASC\", \"city DESC\"."
      },
      "query": {
        "type": "string",
        "description": "Search query"
      },
      "firstname": {
        "type": "string",
        "description": "Any customers with a first name like the parameter"
      },
      "lastname": {
        "type": "string",
        "description": "Any customers with a last name like the parameter"
      },
      "business_name": {
        "type": "string",
        "description": "Any customers with a business name like the parameter"
      },
      "id": {
        "type": "array",
        "items": {
          "type": "integer"
        },
        "description": "Any customers with ID included in the list"
      },
      "not_id": {
        "type": "array",
        "items": {
          "type": "integer"
        },
        "description": "Any customers with ID not included in the list"
      },
      "email": {
        "type": "string",
        "description": "The email value"
      },
      "include_disabled": {
        "type": "string",
        "description": "Whether or not the returned list of customers includes disabled customers"
      },
      "page": {
        "type": "integer",
        "description": "Returns provided page of results, each 'page' contains 25 results"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## repairshopr\_customers\_list\_customers\_autocomplete

Returns a paginated list of customers for autocomplete query

**Parameters:**

| Parameter | Type   | Required | Default | Description  |
| --------- | ------ | -------- | ------- | ------------ |
| `query`   | string | No       | —       | Search query |

<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"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## repairshopr\_customers\_list\_customers\_latest

Returns latest Customer

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

***

## repairshopr\_customers\_list\_leads

Returns a paginated list of Leads

**Parameters:**

| Parameter     | Type       | Required | Default | Description                                                                                                                                                        |
| ------------- | ---------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `statuses`    | string\[]  | No       | —       | Array of statuses. Possible values are "New", "Lead", "First Contact", "Opportunity", "Prospect", "Waiting on Client", "In Negotiation", "Pending", "Won", "Lost". |
| `status_list` | string     | No       | —       | Comma separated list of statuses.                                                                                                                                  |
| `users`       | integer\[] | No       | —       | Array of user IDs.                                                                                                                                                 |
| `mailbox_ids` | integer\[] | No       | —       | Array of Mailbox IDs                                                                                                                                               |
| `has_ticket`  | boolean    | No       | —       | Has Ticket                                                                                                                                                         |
| `query`       | string     | No       | —       | Search query                                                                                                                                                       |
| `page`        | integer    | No       | —       | Returns provided page of results, each 'page' contains 25 results                                                                                                  |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "statuses": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "Array of statuses. Possible values are \"New\", \"Lead\", \"First Contact\", \"Opportunity\", \"Prospect\", \"Waiting on Client\", \"In Negotiation\", \"Pending\", \"Won\", \"Lost\"."
      },
      "status_list": {
        "type": "string",
        "description": "Comma separated list of statuses."
      },
      "users": {
        "type": "array",
        "items": {
          "type": "integer"
        },
        "description": "Array of user IDs."
      },
      "mailbox_ids": {
        "type": "array",
        "items": {
          "type": "integer"
        },
        "description": "Array of Mailbox IDs"
      },
      "has_ticket": {
        "type": "boolean",
        "description": "Has Ticket"
      },
      "query": {
        "type": "string",
        "description": "Search query"
      },
      "page": {
        "type": "integer",
        "description": "Returns provided page of results, each 'page' contains 25 results"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## repairshopr\_customers\_list\_portal\_users

Returns a paginated list of Portal Users

**Parameters:**

| Parameter     | Type    | Required | Default | Description                                                        |
| ------------- | ------- | -------- | ------- | ------------------------------------------------------------------ |
| `customer_id` | integer | No       | —       | Returns Portal Users that belong to a Customer ID                  |
| `email`       | string  | No       | —       | Portal User email                                                  |
| `page`        | integer | No       | —       | Returns provided page of results, each 'page' contains 100 results |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "customer_id": {
        "type": "integer",
        "description": "Returns Portal Users that belong to a Customer ID"
      },
      "email": {
        "type": "string",
        "description": "Portal User email"
      },
      "page": {
        "type": "integer",
        "description": "Returns provided page of results, each 'page' contains 100 results"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## repairshopr\_customers\_list\_search

Search all the things

**Parameters:**

| Parameter | Type   | Required | Default | Description  |
| --------- | ------ | -------- | ------- | ------------ |
| `query`   | string | No       | —       | Search query |

<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"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## repairshopr\_customers\_update\_contacts\_by\_id

Updates an existing Contact

**Parameters:**

| Parameter     | Type    | Required | Default | Description        |
| ------------- | ------- | -------- | ------- | ------------------ |
| `id`          | integer | Yes      | —       | The id value       |
| `address1`    | string  | No       | —       | The address1 value |
| `address2`    | string  | No       | —       | The address2 value |
| `city`        | string  | No       | —       | The city value     |
| `customer_id` | integer | No       | —       | Customer Id        |
| `email`       | string  | No       | —       | The email value    |
| `mobile`      | string  | No       | —       | The mobile value   |
| `name`        | string  | Yes      | —       | The name value     |
| `notes`       | string  | No       | —       | The notes value    |
| `phone`       | string  | No       | —       | The phone value    |
| `state`       | string  | No       | —       | The state value    |
| `title`       | string  | No       | —       | The title value    |
| `zip`         | string  | No       | —       | The zip value      |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The id value"
      },
      "address1": {
        "type": "string",
        "description": "The address1 value"
      },
      "address2": {
        "type": "string",
        "description": "The address2 value"
      },
      "city": {
        "type": "string",
        "description": "The city value"
      },
      "customer_id": {
        "type": "integer",
        "description": "Customer Id"
      },
      "email": {
        "type": "string",
        "description": "The email value"
      },
      "mobile": {
        "type": "string",
        "description": "The mobile value"
      },
      "name": {
        "type": "string",
        "description": "The name value"
      },
      "notes": {
        "type": "string",
        "description": "The notes value"
      },
      "phone": {
        "type": "string",
        "description": "The phone value"
      },
      "state": {
        "type": "string",
        "description": "The state value"
      },
      "title": {
        "type": "string",
        "description": "The title value"
      },
      "zip": {
        "type": "string",
        "description": "The zip value"
      }
    },
    "required": [
      "PCID",
      "id",
      "name"
    ]
  }
  ```
</Expandable>

***

## repairshopr\_customers\_update\_customers\_by\_id

Updates an existing Customer by ID

**Parameters:**

| Parameter            | Type    | Required | Default | Description          |
| -------------------- | ------- | -------- | ------- | -------------------- |
| `id`                 | integer | Yes      | —       | The id value         |
| `address`            | string  | No       | —       | The address value    |
| `address_2`          | string  | No       | —       | Address 2            |
| `business_name`      | string  | No       | —       | Business Name        |
| `city`               | string  | No       | —       | The city value       |
| `consent`            | object  | No       | —       | The consent value    |
| `email`              | string  | No       | —       | The email value      |
| `firstname`          | string  | No       | —       | The firstname value  |
| `get_billing`        | boolean | No       | —       | Get Billing          |
| `get_marketing`      | boolean | No       | —       | Get Marketing        |
| `get_reports`        | boolean | No       | —       | Get Reports          |
| `get_sms`            | boolean | No       | —       | Get Sms              |
| `invoice_cc_emails`  | string  | No       | —       | Invoice Cc Emails    |
| `invoice_term_id`    | integer | No       | —       | Invoice Term Id      |
| `lastname`           | string  | No       | —       | The lastname value   |
| `mobile`             | string  | No       | —       | The mobile value     |
| `no_email`           | boolean | No       | —       | No Email             |
| `notes`              | string  | No       | —       | The notes value      |
| `notification_email` | string  | No       | —       | Notification Email   |
| `opt_out`            | boolean | No       | —       | Opt Out              |
| `phone`              | string  | No       | —       | The phone value      |
| `properties`         | object  | No       | —       | The properties value |
| `ref_customer_id`    | integer | No       | —       | Ref Customer Id      |
| `referred_by`        | string  | No       | —       | Referred By          |
| `state`              | string  | No       | —       | The state value      |
| `tax_rate_id`        | integer | No       | —       | Tax Rate Id          |
| `zip`                | string  | No       | —       | The zip value        |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The id value"
      },
      "address": {
        "type": "string",
        "description": "The address value"
      },
      "address_2": {
        "type": "string",
        "description": "Address 2"
      },
      "business_name": {
        "type": "string",
        "description": "Business Name"
      },
      "city": {
        "type": "string",
        "description": "The city value"
      },
      "consent": {
        "type": "object",
        "description": "The consent value"
      },
      "email": {
        "type": "string",
        "description": "The email value"
      },
      "firstname": {
        "type": "string",
        "description": "The firstname value"
      },
      "get_billing": {
        "type": "boolean",
        "description": "Get Billing"
      },
      "get_marketing": {
        "type": "boolean",
        "description": "Get Marketing"
      },
      "get_reports": {
        "type": "boolean",
        "description": "Get Reports"
      },
      "get_sms": {
        "type": "boolean",
        "description": "Get Sms"
      },
      "invoice_cc_emails": {
        "type": "string",
        "description": "Invoice Cc Emails"
      },
      "invoice_term_id": {
        "type": "integer",
        "description": "Invoice Term Id"
      },
      "lastname": {
        "type": "string",
        "description": "The lastname value"
      },
      "mobile": {
        "type": "string",
        "description": "The mobile value"
      },
      "no_email": {
        "type": "boolean",
        "description": "No Email"
      },
      "notes": {
        "type": "string",
        "description": "The notes value"
      },
      "notification_email": {
        "type": "string",
        "description": "Notification Email"
      },
      "opt_out": {
        "type": "boolean",
        "description": "Opt Out"
      },
      "phone": {
        "type": "string",
        "description": "The phone value"
      },
      "properties": {
        "type": "object",
        "description": "The properties value"
      },
      "ref_customer_id": {
        "type": "integer",
        "description": "Ref Customer Id"
      },
      "referred_by": {
        "type": "string",
        "description": "Referred By"
      },
      "state": {
        "type": "string",
        "description": "The state value"
      },
      "tax_rate_id": {
        "type": "integer",
        "description": "Tax Rate Id"
      },
      "zip": {
        "type": "string",
        "description": "The zip value"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## repairshopr\_customers\_update\_leads\_by\_id

Updates an existing Lead by ID

**Parameters:**

| Parameter                    | Type    | Required | Default | Description                |
| ---------------------------- | ------- | -------- | ------- | -------------------------- |
| `id`                         | integer | Yes      | —       | The id value               |
| `address`                    | string  | No       | —       | The address value          |
| `appointment_time`           | string  | No       | —       | Appointment Time           |
| `appointment_type_id`        | integer | No       | —       | Appointment Type Id        |
| `business_name`              | string  | No       | —       | Business Name              |
| `city`                       | string  | No       | —       | The city value             |
| `contact_id`                 | integer | No       | —       | Contact Id                 |
| `converted`                  | boolean | No       | —       | The converted value        |
| `customer_id`                | integer | No       | —       | Customer Id                |
| `customer_purchase_id`       | integer | No       | —       | Customer Purchase Id       |
| `disabled`                   | boolean | No       | —       | The disabled value         |
| `email`                      | string  | No       | —       | The email value            |
| `first_name`                 | string  | No       | —       | First Name                 |
| `from_check_in`              | boolean | No       | —       | From Check In              |
| `hidden_notes`               | string  | No       | —       | Hidden Notes               |
| `last_name`                  | string  | No       | —       | Last Name                  |
| `likelihood`                 | integer | No       | —       | The likelihood value       |
| `location_id`                | integer | No       | —       | Location Id                |
| `mailbox_id`                 | integer | No       | —       | Mailbox Id                 |
| `message_read`               | boolean | No       | —       | Message Read               |
| `mobile`                     | string  | No       | —       | The mobile value           |
| `opportunity_amount_dollars` | number  | No       | —       | Opportunity Amount Dollars |
| `opportunity_start_date`     | string  | No       | —       | Opportunity Start Date     |
| `phone`                      | string  | No       | —       | The phone value            |
| `properties`                 | object  | No       | —       | The properties value       |
| `signature_data`             | string  | No       | —       | Signature Data             |
| `signature_date`             | string  | No       | —       | Signature Date             |
| `signature_name`             | string  | No       | —       | Signature Name             |
| `state`                      | string  | No       | —       | The state value            |
| `status`                     | string  | No       | —       | The status value           |
| `ticket_description`         | string  | No       | —       | Ticket Description         |
| `ticket_id`                  | integer | No       | —       | Ticket Id                  |
| `ticket_problem_type`        | string  | No       | —       | Ticket Problem Type        |
| `ticket_properties`          | object  | No       | —       | Ticket Properties          |
| `ticket_subject`             | string  | No       | —       | Ticket Subject             |
| `ticket_type_id`             | integer | No       | —       | Ticket Type Id             |
| `user_id`                    | integer | No       | —       | User Id                    |
| `zip`                        | string  | No       | —       | The zip value              |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The id value"
      },
      "address": {
        "type": "string",
        "description": "The address value"
      },
      "appointment_time": {
        "type": "string",
        "description": "Appointment Time"
      },
      "appointment_type_id": {
        "type": "integer",
        "description": "Appointment Type Id"
      },
      "business_name": {
        "type": "string",
        "description": "Business Name"
      },
      "city": {
        "type": "string",
        "description": "The city value"
      },
      "contact_id": {
        "type": "integer",
        "description": "Contact Id"
      },
      "converted": {
        "type": "boolean",
        "description": "The converted value"
      },
      "customer_id": {
        "type": "integer",
        "description": "Customer Id"
      },
      "customer_purchase_id": {
        "type": "integer",
        "description": "Customer Purchase Id"
      },
      "disabled": {
        "type": "boolean",
        "description": "The disabled value"
      },
      "email": {
        "type": "string",
        "description": "The email value"
      },
      "first_name": {
        "type": "string",
        "description": "First Name"
      },
      "from_check_in": {
        "type": "boolean",
        "description": "From Check In"
      },
      "hidden_notes": {
        "type": "string",
        "description": "Hidden Notes"
      },
      "last_name": {
        "type": "string",
        "description": "Last Name"
      },
      "likelihood": {
        "type": "integer",
        "description": "The likelihood value"
      },
      "location_id": {
        "type": "integer",
        "description": "Location Id"
      },
      "mailbox_id": {
        "type": "integer",
        "description": "Mailbox Id"
      },
      "message_read": {
        "type": "boolean",
        "description": "Message Read"
      },
      "mobile": {
        "type": "string",
        "description": "The mobile value"
      },
      "opportunity_amount_dollars": {
        "type": "number",
        "description": "Opportunity Amount Dollars"
      },
      "opportunity_start_date": {
        "type": "string",
        "description": "Opportunity Start Date"
      },
      "phone": {
        "type": "string",
        "description": "The phone value"
      },
      "properties": {
        "type": "object",
        "description": "The properties value"
      },
      "signature_data": {
        "type": "string",
        "description": "Signature Data"
      },
      "signature_date": {
        "type": "string",
        "description": "Signature Date"
      },
      "signature_name": {
        "type": "string",
        "description": "Signature Name"
      },
      "state": {
        "type": "string",
        "description": "The state value"
      },
      "status": {
        "type": "string",
        "description": "The status value"
      },
      "ticket_description": {
        "type": "string",
        "description": "Ticket Description"
      },
      "ticket_id": {
        "type": "integer",
        "description": "Ticket Id"
      },
      "ticket_problem_type": {
        "type": "string",
        "description": "Ticket Problem Type"
      },
      "ticket_properties": {
        "type": "object",
        "description": "Ticket Properties"
      },
      "ticket_subject": {
        "type": "string",
        "description": "Ticket Subject"
      },
      "ticket_type_id": {
        "type": "integer",
        "description": "Ticket Type Id"
      },
      "user_id": {
        "type": "integer",
        "description": "User Id"
      },
      "zip": {
        "type": "string",
        "description": "The zip value"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## repairshopr\_customers\_update\_portal\_users\_by\_id

Updates an existing Portal User by ID

**Parameters:**

| Parameter               | Type    | Required | Default | Description           |
| ----------------------- | ------- | -------- | ------- | --------------------- |
| `id`                    | integer | Yes      | —       | The id value          |
| `contact_id`            | integer | No       | —       | Contact Id            |
| `customer_id`           | integer | No       | —       | Customer Id           |
| `email`                 | string  | No       | —       | The email value       |
| `password`              | string  | No       | —       | The password value    |
| `password_confirmation` | string  | No       | —       | Password Confirmation |
| `portal_group_id`       | integer | No       | —       | Portal Group Id       |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The id value"
      },
      "contact_id": {
        "type": "integer",
        "description": "Contact Id"
      },
      "customer_id": {
        "type": "integer",
        "description": "Customer Id"
      },
      "email": {
        "type": "string",
        "description": "The email value"
      },
      "password": {
        "type": "string",
        "description": "The password value"
      },
      "password_confirmation": {
        "type": "string",
        "description": "Password Confirmation"
      },
      "portal_group_id": {
        "type": "integer",
        "description": "Portal Group Id"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>