---
canonical_url: "https://docs.composio.dev/toolkits/gorilladesk"
markdown_url: "https://docs.composio.dev/toolkits/gorilladesk.md"
product: "platform"
version: null
last_updated: null
---

# GorillaDesk

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

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

## Tools

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | No | Customer email address. |
| `phones` | array | No | Customer phone entries, each with a phone number and GorillaDesk phone type ID. |
| `status` | string ("active" | "inactive" | "lead") | No | Initial customer status: active, inactive, or lead. |
| `company` | string | No | Customer company name. |
| `location` | object | Yes | Required primary service location for the new customer. |
| `last_name` | string | No | Customer last name. |
| `first_name` | string | Yes | Customer first name. |
| `account_number` | string | No | Optional account number. GorillaDesk requires the final character to be a number. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `content` | string | Yes | Text content of the permanent customer note. |
| `customer_id` | string | Yes | Customer ID that will receive the permanent note. |
| `notify_user_ids` | array | No | GorillaDesk user IDs to notify about the new note. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Credits

**Slug:** `GORILLADESK_GET_CREDITS`

Retrieve one customer credit by ID, or list credits, optionally filtering to one customer.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum credits in this page; list mode only. |
| `offset` | integer | No | Zero-based row offset; list mode only. |
| `credit_id` | string | No | Credit ID to retrieve. Omit to list credits. |
| `customer_id` | string | No | Limit list results to one customer. GorillaDesk returns at most one credit when this filter is set. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | array | No | List-mode sort fields: account_number, last_name, first_name, created, or updated; prefix a field with - for descending order. |
| `limit` | integer | No | Maximum customers in this page; list mode only. |
| `offset` | integer | No | Zero-based row offset; list mode only. |
| `states` | array | No | Customer record states to include in list mode. |
| `include` | array | No | Related records to expand in list or detail mode. |
| `statuses` | array | No | Customer business statuses to include in list mode. |
| `customer_id` | string | No | Customer ID to retrieve. Omit to search customers. |
| `created_after` | string | No | Return customers created strictly after this ISO 8601 timestamp. |
| `updated_after` | string | No | Return customers updated strictly after this ISO 8601 timestamp. |
| `account_number` | string | No | Exact account number to match in list mode. |
| `created_before` | string | No | Return customers created strictly before this ISO 8601 timestamp. |
| `updated_before` | string | No | Return customers updated strictly before this ISO 8601 timestamp. |
| `created_on_or_after` | string | No | Return customers created on or after this ISO 8601 timestamp. |
| `updated_on_or_after` | string | No | Return customers updated on or after this ISO 8601 timestamp. |
| `created_on_or_before` | string | No | Return customers created on or before this ISO 8601 timestamp. |
| `updated_on_or_before` | string | No | Return customers updated on or before this ISO 8601 timestamp. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | array | No | Sort list results by date or created; prefix a field with - for descending order. |
| `limit` | integer | No | Maximum documents in this page; list mode only. |
| `job_id` | string | No | Limit list results to one job. |
| `offset` | integer | No | Zero-based row offset; list mode only. |
| `states` | array | No | Document states to include in list mode. |
| `include` | array | No | Expand the related customer in list or detail mode. |
| `keyword` | string | No | Keyword to search in list mode. |
| `statuses` | array | No | Document statuses to include in list mode. |
| `customer_id` | string | No | Limit list results to one customer. |
| `document_id` | string | No | Document ID to retrieve. Omit to search documents. |
| `created_after` | string | No | Return documents created strictly after this ISO 8601 timestamp. |
| `created_before` | string | No | Return documents created strictly before this ISO 8601 timestamp. |
| `created_on_or_after` | string | No | Return documents created on or after this ISO 8601 timestamp. |
| `created_on_or_before` | string | No | Return documents created on or before this ISO 8601 timestamp. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | array | No | Sort by date or created; prefix a field with - for descending order. Used only in list mode. |
| `limit` | integer | No | Maximum estimates in this page; list mode only. |
| `job_id` | string | No | Limit list results to one job. |
| `offset` | integer | No | Zero-based row offset; list mode only. |
| `states` | array | No | Estimate record states to include in list mode. |
| `include` | array | No | Related records to expand in list or detail mode. |
| `keyword` | string | No | Keyword to search in list mode. |
| `statuses` | array | No | Estimate statuses to include in list mode. |
| `date_after` | string | No | Return estimates strictly after this ISO 8601 date-time. |
| `customer_id` | string | No | Limit list results to one customer. |
| `date_before` | string | No | Return estimates strictly before this ISO 8601 date-time. |
| `estimate_id` | string | No | Estimate ID to retrieve. Omit to search estimates. |
| `sign_statuses` | array | No | Estimate signature statuses to include in list mode. |
| `date_on_or_after` | string | No | Return estimates on or after this ISO 8601 date-time. |
| `date_on_or_before` | string | No | Return estimates on or before this ISO 8601 date-time. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | array | No | Sort list results by date or created; prefix a field with - for descending order. |
| `limit` | integer | No | Maximum invoices in this page; list mode only. |
| `job_id` | string | No | Limit list results to one job. |
| `offset` | integer | No | Zero-based row offset; list mode only. |
| `states` | array | No | Invoice record states to include in list mode. |
| `include` | array | No | Related records to expand in list or detail mode. |
| `keyword` | string | No | Keyword to search in list mode. |
| `statuses` | array | No | Invoice payment statuses to include in list mode. |
| `date_after` | string | No | Return invoices strictly after this ISO 8601 date-time. |
| `invoice_id` | string | No | Invoice ID to retrieve. Omit to search invoices. |
| `customer_id` | string | No | Limit list results to one customer. |
| `date_before` | string | No | Return invoices strictly before this ISO 8601 date-time. |
| `sign_statuses` | array | No | Invoice signature statuses to include in list mode. |
| `date_on_or_after` | string | No | Return invoices on or after this ISO 8601 date-time. |
| `date_on_or_before` | string | No | Return invoices on or before this ISO 8601 date-time. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Jobs

**Slug:** `GORILLADESK_GET_JOBS`

Retrieve one job by ID, or search jobs by customer, state, date, keyword, expansions, and sorting.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | array | No | Sort list results by date or created; prefix a field with - for descending order. |
| `limit` | integer | No | Maximum jobs in this page; list mode only. |
| `job_id` | string | No | Job ID to retrieve. Omit to search jobs. |
| `offset` | integer | No | Zero-based row offset; list mode only. |
| `states` | array | No | Job states to include in list mode. |
| `include` | array | No | Related records to expand in list or detail mode. |
| `keyword` | string | No | Keyword to search in list mode. |
| `date_after` | string | No | Return jobs strictly after this ISO 8601 date-time. |
| `customer_id` | string | No | Limit list results to one customer. |
| `date_before` | string | No | Return jobs strictly before this ISO 8601 date-time. |
| `date_on_or_after` | string | No | Return jobs on or after this ISO 8601 date-time. |
| `date_on_or_before` | string | No | Return jobs on or before this ISO 8601 date-time. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Payments

**Slug:** `GORILLADESK_GET_PAYMENTS`

Retrieve one payment by ID, or search payments by customer, invoice, status, date, expansions, and sorting.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | array | No | List-mode sort fields date or created; prefix with - for descending order. |
| `limit` | integer | No | Maximum payments in this page; list mode only. |
| `offset` | integer | No | Zero-based row offset; list mode only. |
| `include` | array | No | Related records to expand. customer is available in list and detail modes; invoice is list-only. |
| `statuses` | array | No | Payment statuses to include in list mode. |
| `date_after` | string | No | Payments strictly after this ISO 8601 date-time. |
| `invoice_id` | string | No | Limit list results to one invoice. |
| `payment_id` | string | No | Payment ID to retrieve. Omit to search payments. |
| `customer_id` | string | No | Limit list results to one customer. |
| `date_before` | string | No | Payments strictly before this ISO 8601 date-time. |
| `date_on_or_after` | string | No | Payments on or after this ISO 8601 date-time. |
| `date_on_or_before` | string | No | Payments on or before this ISO 8601 date-time. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Services

**Slug:** `GORILLADESK_GET_SERVICES`

Retrieve one GorillaDesk service by ID, or list configured services with sorting and offset pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | array | No | List-mode sort fields name or length; prefix with - for descending order. |
| `limit` | integer | No | Maximum services in this page; list mode only. |
| `offset` | integer | No | Zero-based row offset; list mode only. |
| `service_id` | string | No | Service ID to retrieve. Omit to list services. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum users in this page; used only when user_id is omitted. |
| `offset` | integer | No | Zero-based row offset; used only when user_id is omitted. |
| `user_id` | string | No | User ID to retrieve. Omit to list users. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Phone Types

**Slug:** `GORILLADESK_LIST_PHONE_TYPES`

List the configured customer phone-type definitions, including IDs, names, default flags, and states.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum phone types in this page. |
| `offset` | integer | No | Zero-based row offset. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |