Skip to main content
GorillaDesk logo
  • Category: crm
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 13
  • Triggers: 0
  • Slug: GORILLADESK
  • Version: 00000000_00

Tools

Slug: GORILLADESK_CREATE_CUSTOMERCreate 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORILLADESK_CREATE_CUSTOMER_NOTEPermanently 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

string
required
Text content of the permanent customer note.
string
required
Customer ID that will receive the permanent note.
array
GorillaDesk user IDs to notify about the new note.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORILLADESK_GET_COMPANYReturn the company profile selected by the connected GorillaDesk API key, including contact, address, timezone, and office-hours details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORILLADESK_GET_CREDITSRetrieve one customer credit by ID, or list credits, optionally filtering to one customer.

Input Parameters

integer
Maximum credits in this page; list mode only.
integer
Zero-based row offset; list mode only.
string
Credit ID to retrieve. Omit to list credits.
string
Limit list results to one customer. GorillaDesk returns at most one credit when this filter is set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORILLADESK_GET_CUSTOMERSRetrieve one customer by ID, or search and page through customers using status, state, account number, timestamps, expansions, and sorting.

Input Parameters

array
List-mode sort fields: account_number, last_name, first_name, created, or updated; prefix a field with - for descending order.
integer
Maximum customers in this page; list mode only.
integer
Zero-based row offset; list mode only.
array
Customer record states to include in list mode.
array
Related records to expand in list or detail mode.
array
Customer business statuses to include in list mode.
string
Customer ID to retrieve. Omit to search customers.
string
Return customers created strictly after this ISO 8601 timestamp.
string
Return customers updated strictly after this ISO 8601 timestamp.
string
Exact account number to match in list mode.
string
Return customers created strictly before this ISO 8601 timestamp.
string
Return customers updated strictly before this ISO 8601 timestamp.
string
Return customers created on or after this ISO 8601 timestamp.
string
Return customers updated on or after this ISO 8601 timestamp.
string
Return customers created on or before this ISO 8601 timestamp.
string
Return customers updated on or before this ISO 8601 timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORILLADESK_GET_DOCUMENTSRetrieve one document by ID, or search documents by customer, job, state, status, creation time, keyword, and sorting.

Input Parameters

array
Sort list results by date or created; prefix a field with - for descending order.
integer
Maximum documents in this page; list mode only.
string
Limit list results to one job.
integer
Zero-based row offset; list mode only.
array
Document states to include in list mode.
array
Expand the related customer in list or detail mode.
string
Keyword to search in list mode.
array
Document statuses to include in list mode.
string
Limit list results to one customer.
string
Document ID to retrieve. Omit to search documents.
string
Return documents created strictly after this ISO 8601 timestamp.
string
Return documents created strictly before this ISO 8601 timestamp.
string
Return documents created on or after this ISO 8601 timestamp.
string
Return documents created on or before this ISO 8601 timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORILLADESK_GET_ESTIMATESRetrieve one estimate by ID, or search estimates by customer, job, state, status, signature status, date, keyword, expansions, and sorting.

Input Parameters

array
Sort by date or created; prefix a field with - for descending order. Used only in list mode.
integer
Maximum estimates in this page; list mode only.
string
Limit list results to one job.
integer
Zero-based row offset; list mode only.
array
Estimate record states to include in list mode.
array
Related records to expand in list or detail mode.
string
Keyword to search in list mode.
array
Estimate statuses to include in list mode.
string
Return estimates strictly after this ISO 8601 date-time.
string
Limit list results to one customer.
string
Return estimates strictly before this ISO 8601 date-time.
string
Estimate ID to retrieve. Omit to search estimates.
array
Estimate signature statuses to include in list mode.
string
Return estimates on or after this ISO 8601 date-time.
string
Return estimates on or before this ISO 8601 date-time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORILLADESK_GET_INVOICESRetrieve one invoice by ID, or search invoices by customer, job, state, payment/signature status, date, keyword, expansions, and sorting.

Input Parameters

array
Sort list results by date or created; prefix a field with - for descending order.
integer
Maximum invoices in this page; list mode only.
string
Limit list results to one job.
integer
Zero-based row offset; list mode only.
array
Invoice record states to include in list mode.
array
Related records to expand in list or detail mode.
string
Keyword to search in list mode.
array
Invoice payment statuses to include in list mode.
string
Return invoices strictly after this ISO 8601 date-time.
string
Invoice ID to retrieve. Omit to search invoices.
string
Limit list results to one customer.
string
Return invoices strictly before this ISO 8601 date-time.
array
Invoice signature statuses to include in list mode.
string
Return invoices on or after this ISO 8601 date-time.
string
Return invoices on or before this ISO 8601 date-time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORILLADESK_GET_JOBSRetrieve one job by ID, or search jobs by customer, state, date, keyword, expansions, and sorting.

Input Parameters

array
Sort list results by date or created; prefix a field with - for descending order.
integer
Maximum jobs in this page; list mode only.
string
Job ID to retrieve. Omit to search jobs.
integer
Zero-based row offset; list mode only.
array
Job states to include in list mode.
array
Related records to expand in list or detail mode.
string
Keyword to search in list mode.
string
Return jobs strictly after this ISO 8601 date-time.
string
Limit list results to one customer.
string
Return jobs strictly before this ISO 8601 date-time.
string
Return jobs on or after this ISO 8601 date-time.
string
Return jobs on or before this ISO 8601 date-time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORILLADESK_GET_PAYMENTSRetrieve one payment by ID, or search payments by customer, invoice, status, date, expansions, and sorting.

Input Parameters

array
List-mode sort fields date or created; prefix with - for descending order.
integer
Maximum payments in this page; list mode only.
integer
Zero-based row offset; list mode only.
array
Related records to expand. customer is available in list and detail modes; invoice is list-only.
array
Payment statuses to include in list mode.
string
Payments strictly after this ISO 8601 date-time.
string
Limit list results to one invoice.
string
Payment ID to retrieve. Omit to search payments.
string
Limit list results to one customer.
string
Payments strictly before this ISO 8601 date-time.
string
Payments on or after this ISO 8601 date-time.
string
Payments on or before this ISO 8601 date-time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORILLADESK_GET_SERVICESRetrieve one GorillaDesk service by ID, or list configured services with sorting and offset pagination.

Input Parameters

array
List-mode sort fields name or length; prefix with - for descending order.
integer
Maximum services in this page; list mode only.
integer
Zero-based row offset; list mode only.
string
Service ID to retrieve. Omit to list services.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORILLADESK_GET_USERSRetrieve one GorillaDesk user by ID, or list the company’s users when no ID is supplied.

Input Parameters

integer
Maximum users in this page; used only when user_id is omitted.
integer
Zero-based row offset; used only when user_id is omitted.
string
User ID to retrieve. Omit to list users.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GORILLADESK_LIST_PHONE_TYPESList the configured customer phone-type definitions, including IDs, names, default flags, and states.

Input Parameters

integer
Maximum phone types in this page.
integer
Zero-based row offset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not