initdesk

Delete an article. Address the article by ID or slug.

delete_article

Remove the schedule. The organization is open 24/7 afterward.

delete_business_hours

Use this to permanently delete one business-hours date exception by its id. The weekly schedule is left unchanged, and that date falls back to the weekly hours. This cannot be undone.

delete_business_hours_exception

Delete a collection.

delete_collection

Hard-delete the company. Members become ungrouped (`company_id` null). Tickets stay on the person and keep their assignee.

delete_company

Return knowledge base articles for the organization. Filter by collection or publication status with query parameters.

list_articles

Paginated date exceptions for the organization's schedule. Optional from and to limit the list to that inclusive date range.

list_business_hours_exceptions

Return collections as a nested tree. Use include_articles to embed articles per collection node.

list_collection_tree

Return knowledge base collections for the organization's portal.

list_collections

Return companies for the organization. Filter by name with `search` (accent-insensitive) or by an exact claimed domain with `domain`. Each row includes `member_count`.

list_companies

Return saved ticket search filters visible to the caller. Integration tokens receive organization-shared filters only.

list_custom_preset_filters

Return requesters (customers) for the organization. Filter members of a company with `company=<uuid>`, or ungrouped people with `company=ungrouped`.

list_customers

Return all inboxes for the organization. On ticket create, inbox_id is optional: omit to route to the default inbox (is_default: true), or provide an inbox ID from this list to target a specific mailbox. The email channel connection's external_identifier is the branded support address when that identity is enabled and ready, and the hosted initdesk address otherwise.

list_inboxes

List organizations the authenticated user belongs to. Use the organization ID in subsequent API paths. Filter by name with `search`.

list_organizations

Return all tags defined for the organization, including id, name, color, and instructions.

list_tags

Return messages for a ticket.

list_ticket_messages

Return all ticket status values with human-readable labels (enum value and description per entry).

list_ticket_statuses

Return tickets for the organization. By default only non-spam tickets are included; pass `is_spam=true` to list spam tickets. Filter by requester with `customer_id`. Filter by the requester's current company with `company` (UUID). There is no `company=ungrouped` ticket filter in v1.

list_tickets

Update selected article fields. Address the article by ID or slug. Omitted content is preserved. The final status and content must allow empty content only for drafts.

partial_update_article

Use this to change selected fields on one business-hours date exception. Values you send replace what is stored, including clearing an open or close time. The previous value of a field you send is not kept. Fields you omit stay as they are. Use update_business_hours_exception to replace the whole exception, or delete_business_hours_exception to remove it.

partial_update_business_hours_exception

Update selected collection fields.

partial_update_collection

Update selected company fields.

partial_update_company

Update selected requester fields. Set `company_id` to group the person, or `null` to ungroup. This write allows moving someone who already has a company. Changing `company_id` clears `is_company_manager`. Setting `is_company_manager` true requires a current company.

partial_update_customer

Partially update portal settings for the organization.

partial_update_portal_settings

Return pong. Use this to verify Gemini Spark can execute tools/call.

ping

Return an article by ID or slug.

retrieve_article

One schedule for the organization. timezone is an IANA name such as America/Sao_Paulo. weekly_hours is an object whose keys are mon, tue, wed, thu, fri, sat, and sun. Each value is null when that day is closed, or one range {"opens_at": "09:00", "closes_at": "18:00"}. Times are 24-hour HH:MM with no seconds (not HH:MM:SS). The opening minute is inside the range. A close earlier than the open continues overnight. Omitted weekdays are stored as closed. A list of ranges is rejected. Date exceptions are a separate list. No saved schedule means open 24/7 and weekly_hours is {}. is_open_now, next_open (ISO UTC), and next_open_display (organization working language) are read-only.

retrieve_business_hours

Use this to read one business-hours date exception by its id. Returns the calendar date, label, yearly-repeat flag, and open/close times. Both times null means that date is closed. Does not create, change, or delete the exception.

retrieve_business_hours_exception

Return a collection by ID.

retrieve_collection

Return a company by ID.

retrieve_company

Return a saved ticket search filter by ID. Integration tokens may only retrieve organization-shared filters.

retrieve_custom_preset_filter

Return a requester by ID.

retrieve_customer

Return inbox details, including email prefix and whether it is the default inbox for the organization. The email channel connection's external_identifier is the branded support address when that identity is enabled and ready, and the hosted initdesk address otherwise.

retrieve_inbox

Retrieve an organization by its internal ID or public_id.

retrieve_organization

Retrieve the portal favicon URL for the given size (pixels).

retrieve_portal_favicon_url

Retrieve the portal logo URL for the given size. Use a number for a square image (e.g. 128), or a number with 'h'/'w' suffix to constrain height or width while preserving aspect ratio (e.g. 100h or 100w).

retrieve_portal_logo_url

Use this to read the organization's support portal settings, including name, theme, and whether the portal is active. If no portal record exists yet, this call creates one and then returns it. It does not edit an existing portal, delete settings, or send messages.

retrieve_portal_settings

Return a single organization tag by ID, including id, name, color, and instructions.

retrieve_tag

Return full ticket details for the given ticket ID. To retrieve its messages (replies and internal notes), use the `messages` endpoint.

retrieve_ticket

Redirects to the attachment file URL in storage (HTTP redirect response).

retrieve_ticket_attachment