> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# GorillaDesk

> GorillaDesk is field service management software for pest control and other service businesses, covering customers, jobs, estimates, invoices, payments, and related operations.

![GorillaDesk logo](https://mintcdn.com/composio-preview/o1IUBrrsmtgkhmyf/images/toolkits/gorilladesk.svg?fit=max\&auto=format\&n=o1IUBrrsmtgkhmyf\&q=85\&s=82e87c9b85fc89d98e228635577e847e)

* **Category:** crm
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 13
* **Triggers:** 0
* **Slug:** `GORILLADESK`
* **Version:** 00000000\_00

## Tools

> [accordion] Create Customer
>
> **Slug:** `GORILLADESK_CREATE_CUSTOMER`
>
> Create a GorillaDesk customer together with the required primary service location. This is a permanent side effect: GorillaDesk exposes no customer-delete API, so the created business record cannot be removed with this toolkit.
>
> #### Input Parameters
>
> **email** `string`
>
> Customer email address.
>
> **phones** `array`
>
> Customer phone entries, each with a phone number and GorillaDesk phone type ID.
>
> **status** `string ("active" | "inactive" | "lead")`
>
> Initial customer status: active, inactive, or lead.
>
> **company** `string`
>
> Customer company name.
>
> **location** `object` *required*
>
> Required primary service location for the new customer.
>
> **last\_name** `string`
>
> Customer last name.
>
> **first\_name** `string` *required*
>
> Customer first name.
>
> **account\_number** `string`
>
> Optional account number. GorillaDesk requires the final character to be a number.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Customer Note
>
> **Slug:** `GORILLADESK_CREATE_CUSTOMER_NOTE`
>
> Permanently add a text note to a GorillaDesk customer and optionally notify users. The API cannot remove a created note. This action excludes attachments and must not be retried after an ambiguous result because a retry can create a duplicate permanent note.
>
> #### Input Parameters
>
> **content** `string` *required*
>
> Text content of the permanent customer note.
>
> **customer\_id** `string` *required*
>
> Customer ID that will receive the permanent note.
>
> **notify\_user\_ids** `array`
>
> GorillaDesk user IDs to notify about the new note.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Company
>
> **Slug:** `GORILLADESK_GET_COMPANY`
>
> Return the company profile selected by the connected GorillaDesk API key, including contact, address, timezone, and office-hours details.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Credits
>
> **Slug:** `GORILLADESK_GET_CREDITS`
>
> Retrieve one customer credit by ID, or list credits, optionally filtering to one customer.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum credits in this page; list mode only.
>
> **offset** `integer`
>
> Zero-based row offset; list mode only.
>
> **credit\_id** `string`
>
> Credit ID to retrieve. Omit to list credits.
>
> **customer\_id** `string`
>
> Limit list results to one customer. GorillaDesk returns at most one credit when this filter is set.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Customers
>
> **Slug:** `GORILLADESK_GET_CUSTOMERS`
>
> Retrieve one customer by ID, or search and page through customers using status, state, account number, timestamps, expansions, and sorting.
>
> #### Input Parameters
>
> **sort** `array`
>
> List-mode sort fields: account\_number, last\_name, first\_name, created, or updated; prefix a field with - for descending order.
>
> **limit** `integer`
>
> Maximum customers in this page; list mode only.
>
> **offset** `integer`
>
> Zero-based row offset; list mode only.
>
> **states** `array`
>
> Customer record states to include in list mode.
>
> **include** `array`
>
> Related records to expand in list or detail mode.
>
> **statuses** `array`
>
> Customer business statuses to include in list mode.
>
> **customer\_id** `string`
>
> Customer ID to retrieve. Omit to search customers.
>
> **created\_after** `string`
>
> Return customers created strictly after this ISO 8601 timestamp.
>
> **updated\_after** `string`
>
> Return customers updated strictly after this ISO 8601 timestamp.
>
> **account\_number** `string`
>
> Exact account number to match in list mode.
>
> **created\_before** `string`
>
> Return customers created strictly before this ISO 8601 timestamp.
>
> **updated\_before** `string`
>
> Return customers updated strictly before this ISO 8601 timestamp.
>
> **created\_on\_or\_after** `string`
>
> Return customers created on or after this ISO 8601 timestamp.
>
> **updated\_on\_or\_after** `string`
>
> Return customers updated on or after this ISO 8601 timestamp.
>
> **created\_on\_or\_before** `string`
>
> Return customers created on or before this ISO 8601 timestamp.
>
> **updated\_on\_or\_before** `string`
>
> Return customers updated on or before this ISO 8601 timestamp.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Documents
>
> **Slug:** `GORILLADESK_GET_DOCUMENTS`
>
> Retrieve one document by ID, or search documents by customer, job, state, status, creation time, keyword, and sorting.
>
> #### Input Parameters
>
> **sort** `array`
>
> Sort list results by date or created; prefix a field with - for descending order.
>
> **limit** `integer`
>
> Maximum documents in this page; list mode only.
>
> **job\_id** `string`
>
> Limit list results to one job.
>
> **offset** `integer`
>
> Zero-based row offset; list mode only.
>
> **states** `array`
>
> Document states to include in list mode.
>
> **include** `array`
>
> Expand the related customer in list or detail mode.
>
> **keyword** `string`
>
> Keyword to search in list mode.
>
> **statuses** `array`
>
> Document statuses to include in list mode.
>
> **customer\_id** `string`
>
> Limit list results to one customer.
>
> **document\_id** `string`
>
> Document ID to retrieve. Omit to search documents.
>
> **created\_after** `string`
>
> Return documents created strictly after this ISO 8601 timestamp.
>
> **created\_before** `string`
>
> Return documents created strictly before this ISO 8601 timestamp.
>
> **created\_on\_or\_after** `string`
>
> Return documents created on or after this ISO 8601 timestamp.
>
> **created\_on\_or\_before** `string`
>
> Return documents created on or before this ISO 8601 timestamp.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Estimates
>
> **Slug:** `GORILLADESK_GET_ESTIMATES`
>
> Retrieve one estimate by ID, or search estimates by customer, job, state, status, signature status, date, keyword, expansions, and sorting.
>
> #### Input Parameters
>
> **sort** `array`
>
> Sort by date or created; prefix a field with - for descending order. Used only in list mode.
>
> **limit** `integer`
>
> Maximum estimates in this page; list mode only.
>
> **job\_id** `string`
>
> Limit list results to one job.
>
> **offset** `integer`
>
> Zero-based row offset; list mode only.
>
> **states** `array`
>
> Estimate record states to include in list mode.
>
> **include** `array`
>
> Related records to expand in list or detail mode.
>
> **keyword** `string`
>
> Keyword to search in list mode.
>
> **statuses** `array`
>
> Estimate statuses to include in list mode.
>
> **date\_after** `string`
>
> Return estimates strictly after this ISO 8601 date-time.
>
> **customer\_id** `string`
>
> Limit list results to one customer.
>
> **date\_before** `string`
>
> Return estimates strictly before this ISO 8601 date-time.
>
> **estimate\_id** `string`
>
> Estimate ID to retrieve. Omit to search estimates.
>
> **sign\_statuses** `array`
>
> Estimate signature statuses to include in list mode.
>
> **date\_on\_or\_after** `string`
>
> Return estimates on or after this ISO 8601 date-time.
>
> **date\_on\_or\_before** `string`
>
> Return estimates on or before this ISO 8601 date-time.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Invoices
>
> **Slug:** `GORILLADESK_GET_INVOICES`
>
> Retrieve one invoice by ID, or search invoices by customer, job, state, payment/signature status, date, keyword, expansions, and sorting.
>
> #### Input Parameters
>
> **sort** `array`
>
> Sort list results by date or created; prefix a field with - for descending order.
>
> **limit** `integer`
>
> Maximum invoices in this page; list mode only.
>
> **job\_id** `string`
>
> Limit list results to one job.
>
> **offset** `integer`
>
> Zero-based row offset; list mode only.
>
> **states** `array`
>
> Invoice record states to include in list mode.
>
> **include** `array`
>
> Related records to expand in list or detail mode.
>
> **keyword** `string`
>
> Keyword to search in list mode.
>
> **statuses** `array`
>
> Invoice payment statuses to include in list mode.
>
> **date\_after** `string`
>
> Return invoices strictly after this ISO 8601 date-time.
>
> **invoice\_id** `string`
>
> Invoice ID to retrieve. Omit to search invoices.
>
> **customer\_id** `string`
>
> Limit list results to one customer.
>
> **date\_before** `string`
>
> Return invoices strictly before this ISO 8601 date-time.
>
> **sign\_statuses** `array`
>
> Invoice signature statuses to include in list mode.
>
> **date\_on\_or\_after** `string`
>
> Return invoices on or after this ISO 8601 date-time.
>
> **date\_on\_or\_before** `string`
>
> Return invoices on or before this ISO 8601 date-time.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Jobs
>
> **Slug:** `GORILLADESK_GET_JOBS`
>
> Retrieve one job by ID, or search jobs by customer, state, date, keyword, expansions, and sorting.
>
> #### Input Parameters
>
> **sort** `array`
>
> Sort list results by date or created; prefix a field with - for descending order.
>
> **limit** `integer`
>
> Maximum jobs in this page; list mode only.
>
> **job\_id** `string`
>
> Job ID to retrieve. Omit to search jobs.
>
> **offset** `integer`
>
> Zero-based row offset; list mode only.
>
> **states** `array`
>
> Job states to include in list mode.
>
> **include** `array`
>
> Related records to expand in list or detail mode.
>
> **keyword** `string`
>
> Keyword to search in list mode.
>
> **date\_after** `string`
>
> Return jobs strictly after this ISO 8601 date-time.
>
> **customer\_id** `string`
>
> Limit list results to one customer.
>
> **date\_before** `string`
>
> Return jobs strictly before this ISO 8601 date-time.
>
> **date\_on\_or\_after** `string`
>
> Return jobs on or after this ISO 8601 date-time.
>
> **date\_on\_or\_before** `string`
>
> Return jobs on or before this ISO 8601 date-time.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Payments
>
> **Slug:** `GORILLADESK_GET_PAYMENTS`
>
> Retrieve one payment by ID, or search payments by customer, invoice, status, date, expansions, and sorting.
>
> #### Input Parameters
>
> **sort** `array`
>
> List-mode sort fields date or created; prefix with - for descending order.
>
> **limit** `integer`
>
> Maximum payments in this page; list mode only.
>
> **offset** `integer`
>
> Zero-based row offset; list mode only.
>
> **include** `array`
>
> Related records to expand. customer is available in list and detail modes; invoice is list-only.
>
> **statuses** `array`
>
> Payment statuses to include in list mode.
>
> **date\_after** `string`
>
> Payments strictly after this ISO 8601 date-time.
>
> **invoice\_id** `string`
>
> Limit list results to one invoice.
>
> **payment\_id** `string`
>
> Payment ID to retrieve. Omit to search payments.
>
> **customer\_id** `string`
>
> Limit list results to one customer.
>
> **date\_before** `string`
>
> Payments strictly before this ISO 8601 date-time.
>
> **date\_on\_or\_after** `string`
>
> Payments on or after this ISO 8601 date-time.
>
> **date\_on\_or\_before** `string`
>
> Payments on or before this ISO 8601 date-time.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Services
>
> **Slug:** `GORILLADESK_GET_SERVICES`
>
> Retrieve one GorillaDesk service by ID, or list configured services with sorting and offset pagination.
>
> #### Input Parameters
>
> **sort** `array`
>
> List-mode sort fields name or length; prefix with - for descending order.
>
> **limit** `integer`
>
> Maximum services in this page; list mode only.
>
> **offset** `integer`
>
> Zero-based row offset; list mode only.
>
> **service\_id** `string`
>
> Service ID to retrieve. Omit to list services.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Users
>
> **Slug:** `GORILLADESK_GET_USERS`
>
> Retrieve one GorillaDesk user by ID, or list the company's users when no ID is supplied.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum users in this page; used only when user\_id is omitted.
>
> **offset** `integer`
>
> Zero-based row offset; used only when user\_id is omitted.
>
> **user\_id** `string`
>
> User ID to retrieve. Omit to list users.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Phone Types
>
> **Slug:** `GORILLADESK_LIST_PHONE_TYPES`
>
> List the configured customer phone-type definitions, including IDs, names, default flags, and states.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum phone types in this page.
>
> **offset** `integer`
>
> Zero-based row offset.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
