Gorelo MCP by usefulapi
Read tickets, devices, alerts and invoices; create tickets, add comments, log time in Gorelo.
Should I use this
Quality & Safety
Findings (1)
- LOWin gorelo_list_agent_pending_updates
Based on automated analysis of tool definitions and protocol compliance.
Context Cost
This is the approximate number of tokens consumed each time the server's tools are loaded into a model's context. Higher counts reduce the attention available for other tasks.
Install
One-Click Install
Add this to your `claude_desktop_config.json` file:
{
"mcpServers": {
"gorelo": {
"url": "https://gorelo.usefulapi.io/mcp"
}
}
}Remote endpoints
https://gorelo.usefulapi.io/mcpstreamable-httpWhat it can do
Tool inventory
Tools (31)
🟢gorelo_list_clients(cursor, page_size, query, status_ids, group_ids, ...)
List the MSP's clients (customers). Good first call to find a client id. API: GET /v1/clients.
Input Schema
{
"type": "object",
"properties": {
"cursor": {
"description": "Cursor from DataContext.Pagination.NextCursor of the previous page. Omit for the first page.",
"type": "string"
},
"page_size": {
"description": "Items per page, 1-200 (default 50).",
"type": "integer",
"minimum": 1,
"maximum": 200
},
"query": {
"description": "Keyword to match against the client name.",
"type": "string",
"maxLength": 200
},
"status_ids": {
"description": "Comma-separated client status ids, for example \"12,15\".",
"type": "string"
},
"group_ids": {
"description": "Comma-separated client group ids, for example \"12,15\".",
"type": "string"
},
"updated_since": {
"description": "ISO-8601 timestamp, keep clients updated at or after it.",
"type": "string"
},
"created_since": {
"description": "ISO-8601 timestamp, keep clients created at or after it.",
"type": "string"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢gorelo_get_client(client_id)
Get one client by id with its details. API: GET /v1/clients/{clientId}.
Input Schema
{
"type": "object",
"properties": {
"client_id": {
"type": "string",
"minLength": 1,
"description": "Client id (integer, from gorelo_list_clients)."
}
},
"required": [
"client_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢gorelo_list_client_locations(client_id)
List the locations (sites) of one client. API: GET /v1/clients/{clientId}/locations.
Input Schema
{
"type": "object",
"properties": {
"client_id": {
"type": "string",
"minLength": 1,
"description": "Client id (integer)."
}
},
"required": [
"client_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢gorelo_list_contacts(cursor, page_size, client_ids, query, status_ids, ...)
List client contacts (end users). API: GET /v1/contacts.
Input Schema
{
"type": "object",
"properties": {
"cursor": {
"description": "Cursor from DataContext.Pagination.NextCursor of the previous page. Omit for the first page.",
"type": "string"
},
"page_size": {
"description": "Items per page, 1-200 (default 50).",
"type": "integer",
"minimum": 1,
"maximum": 200
},
"client_ids": {
"description": "Comma-separated client ids, for example \"12,15\".",
"type": "string"
},
"query": {
"description": "Keyword matched against email, first name and last name.",
"type": "string",
"maxLength": 200
},
"status_ids": {
"description": "Comma-separated contact status (1 Active, 3 Temporary, 4 Archived) ids, for example \"12,15\".",
"type": "string"
},
"location_ids": {
"description": "Comma-separated location ids, for example \"12,15\".",
"type": "string"
},
"updated_since": {
"description": "ISO-8601 timestamp, keep contacts updated at or after it.",
"type": "string"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢gorelo_get_contact(contact_id)
Get one contact by id. API: GET /v1/contacts/{contactId}.
Input Schema
{
"type": "object",
"properties": {
"contact_id": {
"type": "string",
"minLength": 1,
"description": "Contact id (integer, from gorelo_list_contacts)."
}
},
"required": [
"contact_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢gorelo_list_tickets(cursor, page_size, status_ids, client_ids, priority_ids, ...)
List service tickets, newest activity first, with status, priority, client, assignees and SLA. Use the list_ticket_statuses/types/priorities tools to learn the ids for filters. API: GET /v1/tickets.
Input Schema
{
"type": "object",
"properties": {
"cursor": {
"description": "Cursor from DataContext.Pagination.NextCursor of the previous page. Omit for the first page.",
"type": "string"
},
"page_size": {
"description": "Items per page, 1-200 (default 50).",
"type": "integer",
"minimum": 1,
"maximum": 200
},
"status_ids": {
"description": "Comma-separated ticket status ids, for example \"12,15\".",
"type": "string"
},
"client_ids": {
"description": "Comma-separated client ids, for example \"12,15\".",
"type": "string"
},
"priority_ids": {
"description": "Comma-separated priority ids, for example \"12,15\".",
"type": "string"
},
"type_ids": {
"description": "Comma-separated ticket type ids, for example \"12,15\".",
"type": "string"
},
"lead_assignee_ids": {
"description": "Comma-separated technician (lead assignee) ids, for example \"12,15\".",
"type": "string"
},
"contact_ids": {
"description": "Comma-separated contact ids, for example \"12,15\".",
"type": "string"
},
"tag_ids": {
"description": "Comma-separated tag ids, for example \"12,15\".",
"type": "string"
},
"group_ids": {
"description": "Comma-separated technician group ids, for example \"12,15\".",
"type": "string"
},
"device_ids": {
"description": "Comma-separated agent asset (guid) ids, for example \"12,15\".",
"type": "string"
},
"query": {
"description": "Keyword matched against the ticket title, number and display number.",
"type": "string",
"maxLength": 200
},
"sort_by": {
"type": "string",
"enum": [
"updatedOn",
"createdOn"
]
},
"sort_order": {
"type": "string",
"enum": [
"asc",
"desc"
]
},
"created_since": {
"description": "ISO-8601 timestamp, keep tickets created at or after it.",
"type": "string"
},
"created_before": {
"description": "ISO-8601 timestamp, keep tickets created before it.",
"type": "string"
},
"updated_since": {
"description": "ISO-8601 timestamp, keep tickets updated at or after it.",
"type": "string"
},
"closed_since": {
"description": "ISO-8601 timestamp, keep tickets closed at or after it.",
"type": "string"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢gorelo_get_ticket(ticket_id)
Get one ticket by id (uuid). API: GET /v1/tickets/{ticketId}.
Input Schema
{
"type": "object",
"properties": {
"ticket_id": {
"type": "string",
"minLength": 1,
"description": "Ticket id (uuid, from gorelo_list_tickets)."
}
},
"required": [
"ticket_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢gorelo_list_ticket_comments(cursor, page_size, ticket_id, sort_order, conversation_type, ...)
List the comments (public replies, private notes) on a ticket. API: GET /v1/tickets/{ticketId}/comments.
Input Schema
{
"type": "object",
"properties": {
"cursor": {
"description": "Cursor from DataContext.Pagination.NextCursor of the previous page. Omit for the first page.",
"type": "string"
},
"page_size": {
"description": "Items per page, 1-200 (default 50).",
"type": "integer",
"minimum": 1,
"maximum": 200
},
"ticket_id": {
"type": "string",
"minLength": 1,
"description": "Ticket id (uuid)."
},
"sort_order": {
"type": "string",
"enum": [
"asc",
"desc"
]
},
"conversation_type": {
"description": "Conversation kinds to include: 1 Public, 2 Private, 3 Side Conversation, 4 Approval. Comma-separated, or a single value together with conversation_id.",
"type": "string"
},
"conversation_id": {
"description": "Filter to one conversation id (from the ticket's conversations).",
"type": "string"
}
},
"required": [
"ticket_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢gorelo_list_ticket_statuses
List the ticket statuses (id and name) used to filter or update tickets. API: GET /v1/tickets/statuses.
Input Schema
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢gorelo_list_ticket_types
List the ticket types. API: GET /v1/tickets/types.
Input Schema
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢gorelo_list_ticket_priorities
List the ticket priorities. API: GET /v1/tickets/priorities.
Input Schema
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢gorelo_list_agent_assets(cursor, page_size, status_ids, client_ids, query, ...)
List agent (RMM managed device) assets with status, OS and client. API: GET /v1/assets/agents.
Input Schema
{
"type": "object",
"properties": {
"cursor": {
"description": "Cursor from DataContext.Pagination.NextCursor of the previous page. Omit for the first page.",
"type": "string"
},
"page_size": {
"description": "Items per page, 1-200 (default 50).",
"type": "integer",
"minimum": 1,
"maximum": 200
},
"status_ids": {
"description": "Comma-separated device status (2 Online, 3 Offline, 4 Pending Delete; the API also accepts 1 and 6, see the API docs) ids, for example \"12,15\".",
"type": "string"
},
"client_ids": {
"description": "Comma-separated client ids, for example \"12,15\".",
"type": "string"
},
"query": {
"description": "Keyword matched against device name, display name and description.",
"type": "string",
"maxLength": 200
},
"updated_since": {
"description": "ISO-8601 timestamp, keep devices updated at or after it.",
"type": "string"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢gorelo_get_agent_asset(agent_asset_id)
Get one managed device by id (guid). API: GET /v1/assets/agents/{agentAssetId}.
Input Schema
{
"type": "object",
"properties": {
"agent_asset_id": {
"type": "string",
"minLength": 1,
"description": "Agent asset id (guid, from gorelo_list_agent_assets)."
}
},
"required": [
"agent_asset_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢gorelo_get_agent_hardware(agent_asset_id)
Get a managed device's processors, memory and disks. API: GET /v1/assets/agents/{agentAssetId}/hardware.
Input Schema
{
"type": "object",
"properties": {
"agent_asset_id": {
"type": "string",
"minLength": 1,
"description": "Agent asset id (guid)."
}
},
"required": [
"agent_asset_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢gorelo_list_agent_pending_updates(agent_asset_id)
List the Windows updates pending on a managed device, from its last scan (no new scan starts). API: GET /v1/assets/agents/{agentAssetId}/patches/available.
Input Schema
{
"type": "object",
"properties": {
"agent_asset_id": {
"type": "string",
"minLength": 1,
"description": "Agent asset id (guid) of a Windows agent."
}
},
"required": [
"agent_asset_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢gorelo_list_custom_assets(cursor, page_size, client_ids, query, updated_since)
List custom (non-agent) assets such as printers, switches and licences. API: GET /v1/assets/custom.
Input Schema
{
"type": "object",
"properties": {
"cursor": {
"description": "Cursor from DataContext.Pagination.NextCursor of the previous page. Omit for the first page.",
"type": "string"
},
"page_size": {
"description": "Items per page, 1-200 (default 50).",
"type": "integer",
"minimum": 1,
"maximum": 200
},
"client_ids": {
"description": "Comma-separated client ids, for example \"12,15\".",
"type": "string"
},
"query": {
"description": "Keyword matched against the asset name.",
"type": "string",
"maxLength": 200
},
"updated_since": {
"description": "ISO-8601 timestamp, keep assets updated at or after it.",
"type": "string"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢gorelo_list_alerts(cursor, page_size, status_ids, type_ids, client_ids, ...)
List alerts (uptime, script, external, ...) newest first. API: GET /v1/alerts.
Input Schema
{
"type": "object",
"properties": {
"cursor": {
"description": "Cursor from DataContext.Pagination.NextCursor of the previous page. Omit for the first page.",
"type": "string"
},
"page_size": {
"description": "Items per page, 1-200 (default 50).",
"type": "integer",
"minimum": 1,
"maximum": 200
},
"status_ids": {
"description": "Comma-separated alert status (1 New, 2 Dismissed, 3 Ticketed) ids, for example \"12,15\".",
"type": "string"
},
"type_ids": {
"description": "Comma-separated alert type (1 Uptime, 2 API, 3 Script, 4 External, ...) ids, for example \"12,15\".",
"type": "string"
},
"client_ids": {
"description": "Comma-separated client ids, for example \"12,15\".",
"type": "string"
},
"agent_asset_ids": {
"description": "Comma-separated agent asset (guid) ids, for example \"12,15\".",
"type": "string"
},
"created_since": {
"description": "ISO-8601 timestamp, keep alerts raised at or after it.",
"type": "string"
},
"created_before": {
"description": "ISO-8601 timestamp, keep alerts raised before it.",
"type": "string"
},
"sort_order": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢gorelo_get_alert(alert_id)
Get one alert by id (guid). API: GET /v1/alerts/{alertId}.
Input Schema
{
"type": "object",
"properties": {
"alert_id": {
"type": "string",
"minLength": 1,
"description": "Alert id (guid, from gorelo_list_alerts)."
}
},
"required": [
"alert_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢gorelo_list_projects(cursor, page_size, status_ids, client_ids, query, ...)
List projects with status, client and lead. API: GET /v1/projects.
Input Schema
{
"type": "object",
"properties": {
"cursor": {
"description": "Cursor from DataContext.Pagination.NextCursor of the previous page. Omit for the first page.",
"type": "string"
},
"page_size": {
"description": "Items per page, 1-200 (default 50).",
"type": "integer",
"minimum": 1,
"maximum": 200
},
"status_ids": {
"description": "Comma-separated project status ids, for example \"12,15\".",
"type": "string"
},
"client_ids": {
"description": "Comma-separated client ids, for example \"12,15\".",
"type": "string"
},
"query": {
"description": "Keyword matched against the project name.",
"type": "string",
"maxLength": 200
},
"sort_by": {
"description": "Sort field, for example updatedOn or createdOn.",
"type": "string"
},
"sort_order": {
"type": "string",
"enum": [
"asc",
"desc"
]
},
"updated_since": {
"description": "ISO-8601 timestamp, keep projects updated at or after it.",
"type": "string"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢gorelo_list_project_tasks(cursor, page_size, project_id, status_ids, assignee_ids, ...)
List the tasks of one project. API: GET /v1/projects/{projectId}/tasks.
Input Schema
{
"type": "object",
"properties": {
"cursor": {
"description": "Cursor from DataContext.Pagination.NextCursor of the previous page. Omit for the first page.",
"type": "string"
},
"page_size": {
"description": "Items per page, 1-200 (default 50).",
"type": "integer",
"minimum": 1,
"maximum": 200
},
"project_id": {
"type": "string",
"minLength": 1,
"description": "Project id (guid, from gorelo_list_projects)."
},
"status_ids": {
"description": "Comma-separated task status (1 Not started, 2 Working on it, 3 On hold, 4 Done) ids, for example \"12,15\".",
"type": "string"
},
"assignee_ids": {
"description": "Comma-separated technician ids, for example \"12,15\".",
"type": "string"
},
"incomplete_only": {
"description": "When true, drop tasks in the Done status.",
"type": "boolean"
},
"sort_by": {
"type": "string",
"enum": [
"boardOrder",
"createdOn",
"updatedOn"
]
},
"sort_order": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
"required": [
"project_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢gorelo_list_time_entries(cursor, page_size, client_ids, ticket_ids, task_ids, ...)
List logged time across tickets and tasks. API: GET /v1/time-entries.
Input Schema
{
"type": "object",
"properties": {
"cursor": {
"description": "Cursor from DataContext.Pagination.NextCursor of the previous page. Omit for the first page.",
"type": "string"
},
"page_size": {
"description": "Items per page, 1-200 (default 50).",
"type": "integer",
"minimum": 1,
"maximum": 200
},
"client_ids": {
"description": "Comma-separated client ids, for example \"12,15\".",
"type": "string"
},
"ticket_ids": {
"description": "Comma-separated ticket (uuid) ids, for example \"12,15\".",
"type": "string"
},
"task_ids": {
"description": "Comma-separated task (guid) ids, for example \"12,15\".",
"type": "string"
},
"user_ids": {
"description": "Comma-separated user ids, for example \"12,15\".",
"type": "string"
},
"invoice_ids": {
"description": "Comma-separated invoice ids, for example \"12,15\".",
"type": "string"
},
"started_since": {
"description": "ISO-8601 timestamp, keep entries whose work started at or after it.",
"type": "string"
},
"started_before": {
"description": "ISO-8601 timestamp, keep entries whose work started before it.",
"type": "string"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢gorelo_list_invoices(cursor, page_size, client_ids, status_ids, contract_ids, ...)
List invoices with status, totals and client. API: GET /v1/invoices.
Input Schema
{
"type": "object",
"properties": {
"cursor": {
"description": "Cursor from DataContext.Pagination.NextCursor of the previous page. Omit for the first page.",
"type": "string"
},
"page_size": {
"description": "Items per page, 1-200 (default 50).",
"type": "integer",
"minimum": 1,
"maximum": 200
},
"client_ids": {
"description": "Comma-separated client ids, for example \"12,15\".",
"type": "string"
},
"status_ids": {
"description": "Comma-separated invoice status (1 Draft, 2 Submitted, 3 Paid, 4 Void, 5 Approved) ids, for example \"12,15\".",
"type": "string"
},
"contract_ids": {
"description": "Comma-separated contract ids, for example \"12,15\".",
"type": "string"
},
"query": {
"description": "Free text matched against invoice number, reference and name.",
"type": "string"
},
"invoice_date_since": {
"description": "Date (yyyy-mm-dd): invoices dated at or after it.",
"type": "string"
},
"invoice_date_before": {
"description": "Date (yyyy-mm-dd): invoices dated before it.",
"type": "string"
},
"due_date_before": {
"description": "Date (yyyy-mm-dd): invoices due before it (find overdue invoices).",
"type": "string"
},
"sort_by": {
"type": "string",
"enum": [
"createdOn",
"updatedOn",
"date",
"dueDate",
"totalAmount"
]
},
"sort_order": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢gorelo_get_invoice(invoice_id)
Get one invoice with its line items and attachments. API: GET /v1/invoices/{invoiceId}.
Input Schema
{
"type": "object",
"properties": {
"invoice_id": {
"type": "string",
"minLength": 1,
"description": "Invoice id (from gorelo_list_invoices)."
}
},
"required": [
"invoice_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢gorelo_list_contracts(cursor, page_size, client_ids, status_ids, query)
List billing contracts with their service lines. API: GET /v1/contracts.
Input Schema
{
"type": "object",
"properties": {
"cursor": {
"description": "Cursor from DataContext.Pagination.NextCursor of the previous page. Omit for the first page.",
"type": "string"
},
"page_size": {
"description": "Items per page, 1-200 (default 50).",
"type": "integer",
"minimum": 1,
"maximum": 200
},
"client_ids": {
"description": "Comma-separated client ids, for example \"12,15\".",
"type": "string"
},
"status_ids": {
"description": "Comma-separated contract status ids, for example \"12,15\".",
"type": "string"
},
"query": {
"description": "Keyword matched against the contract name.",
"type": "string"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢gorelo_list_users(cursor, page_size, status_ids, query, group_ids)
List users (technicians) with role and status; use their ids as assignee ids. API: GET /v1/organization/users.
Input Schema
{
"type": "object",
"properties": {
"cursor": {
"description": "Cursor from DataContext.Pagination.NextCursor of the previous page. Omit for the first page.",
"type": "string"
},
"page_size": {
"description": "Items per page, 1-200 (default 50).",
"type": "integer",
"minimum": 1,
"maximum": 200
},
"status_ids": {
"description": "Comma-separated user status ids, for example \"12,15\".",
"type": "string"
},
"query": {
"description": "Keyword matched against the user name or email.",
"type": "string"
},
"group_ids": {
"description": "Comma-separated technician group ids, for example \"12,15\".",
"type": "string"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢gorelo_list_groups
List technician groups (ids are needed to create a ticket). API: GET /v1/organization/groups.
Input Schema
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴gorelo_create_ticket(title, status_id, group_id, type_id, description, ...)
WRITE: create a service ticket. Needs status_id, group_id and type_id (use gorelo_list_ticket_statuses, gorelo_list_groups, gorelo_list_ticket_types). Set send_created_email true only if the contact must get a 'ticket created' email. API: POST /v1/tickets.
Input Schema
{
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"maxLength": 250,
"description": "Ticket title."
},
"status_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Initial status id."
},
"group_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Technician group id."
},
"type_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Ticket type id."
},
"description": {
"description": "Ticket body as HTML. Plain text is wrapped in a paragraph. Send < and > as < and >.",
"type": "string"
},
"client_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"location_id": {
"description": "Needs client_id.",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"contact_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"priority_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"source_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"lead_assignee_id": {
"description": "Technician id.",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"tag_ids": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"agent_asset_ids": {
"description": "Managed device ids (guid) to link.",
"type": "array",
"items": {
"type": "string"
}
},
"send_created_email": {
"description": "Email the contact that the ticket was created (default false).",
"type": "boolean"
}
},
"required": [
"title",
"status_id",
"group_id",
"type_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴gorelo_update_ticket(ticket_id, title, status_id, priority_id, type_id, ...)
WRITE: change fields of a ticket (status, priority, assignee, title, tags). Only the fields you send change. Each change notifies and logs as in the app. Changing the client clears the ticket's contact and assets. API: PATCH /v1/tickets/{ticketId}.
Input Schema
{
"type": "object",
"properties": {
"ticket_id": {
"type": "string",
"minLength": 1,
"description": "Ticket id (uuid)."
},
"title": {
"type": "string",
"maxLength": 250
},
"status_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"priority_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"type_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"lead_assignee_id": {
"description": "Technician id. Send 0 to unassign.",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"tag_ids": {
"description": "Replaces the whole tag list; [] clears it.",
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"client_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"contact_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"ticket_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴gorelo_add_ticket_comment(ticket_id, body, visibility)
WRITE: add a comment to a ticket's main thread. A 'public' comment is a reply the client sees and may be emailed to them; a 'private' comment is an internal note. Do not retry after an unclear error: that can post twice. API: POST /v1/tickets/{ticketId}/comments.
Input Schema
{
"type": "object",
"properties": {
"ticket_id": {
"type": "string",
"minLength": 1,
"description": "Ticket id (uuid)."
},
"body": {
"type": "string",
"minLength": 1,
"description": "Comment body as HTML. Send < and > in text as < and >."
},
"visibility": {
"type": "string",
"enum": [
"public",
"private"
],
"description": "public = visible to the client; private = internal note."
}
},
"required": [
"ticket_id",
"body",
"visibility"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴gorelo_update_alert_status(alert_id, status, ticket_id)
WRITE: dismiss an alert, restore it to New, or link it to an open ticket (status 'ticketed' needs ticket_id). The change applies to the alert's whole stack, as in the app. API: PATCH /v1/alerts/{alertId}.
Input Schema
{
"type": "object",
"properties": {
"alert_id": {
"type": "string",
"minLength": 1,
"description": "Alert id (guid)."
},
"status": {
"type": "string",
"enum": [
"new",
"dismissed",
"ticketed"
]
},
"ticket_id": {
"description": "Open ticket id (uuid). Required when status is ticketed.",
"type": "string"
}
},
"required": [
"alert_id",
"status"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴gorelo_log_time_entry(ticket_id, task_id, actual_hours, started_on, ended_on, ...)
WRITE: log work time against a ticket (or a project task). Give any two of started_on, ended_on and actual_hours (the API derives the third). Billing role, work type and billable status default from the ticket. Do not retry after an unclear error: that can log twice. API: POST /v1/time-entries.
Input Schema
{
"type": "object",
"properties": {
"ticket_id": {
"description": "Ticket id (uuid). Send this or task_id.",
"type": "string"
},
"task_id": {
"description": "Project task id (guid). Send this or ticket_id.",
"type": "string"
},
"actual_hours": {
"description": "Hours worked, decimal.",
"type": "number",
"exclusiveMinimum": 0
},
"started_on": {
"description": "ISO-8601 UTC start of the work.",
"type": "string"
},
"ended_on": {
"description": "ISO-8601 UTC end of the work.",
"type": "string"
},
"comment": {
"description": "Note that describes the work.",
"type": "string"
},
"billable_status_id": {
"description": "1 Billable, 2 No charge, 3 Non-billable.",
"type": "integer",
"minimum": 1,
"maximum": 3
},
"user_id": {
"description": "Technician id the time belongs to.",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Community
Evidence