read thedocs.

[ docs // guides & reference ]

Connector setup guides, tool references, auth flows, and platform concepts — everything you need to run StackJack, in one place.

34 connectors documented // 6,712 tools referenced // setup, auth & platform guides

No pages match that search. Clear it

← All documentation

Gorelo Tools

gorelo_ · 18 tools · Free 12 · Pro 6 Static X-API-Key header (per-key scopes chosen at key creation; a 403 means the key lacks that endpoint's scope); regional host in InstanceUrl (US api.usw.gorelo.io / AU api.aue.gorelo.io) used as BaseAddress with root-relative v1/ paths; NO pagination model and no page-size cap; PATCH targets the COLLECTION path (v1/contacts / v1/clients) with the record id in the body (no / route); POST v1/alerts/ keeps its trailing slash; tickets are write-mostly (create + status/tag/type lookups — no ticket list/get in the public API); raw JSON passthrough.

Contacts

Tool Plan Access Description
gorelo_create_contact Pro Write [Gorelo] Create a contact under a client. Provide a JSON object body. Fields: clientId (integer, required — the owning client from gorelo_list_clients), firstName, lastName, clientLocationId (integer, optional — from gorelo_list_client_locations), primaryEmail, secondaryEmail (array of strings), mobilePhone, mobilePhoneCountryCode, officePhone, officePhoneCountryCode, jobTitle, department, timeZone, description. Requires an API key with the contacts edit scope (a 403 means the key lacks it).
gorelo_get_contact Free Read-only [Gorelo] Get a single contact by its numeric id (from gorelo_list_contacts). Returns the full contact record (name, emails, phones, client/location, job title, etc.). Requires an API key with the contacts read scope.
gorelo_list_contacts Free Read-only [Gorelo] List contacts (people) in the Gorelo CRM. Optionally filter by contactIds (a comma-delimited string of numeric contact ids) and/or clientId (a numeric client id from gorelo_list_clients) to return only that client's contacts. With no filters, returns all contacts. Requires an API key with the contacts read scope (a 403 means the key lacks it). The public API has no pagination, so the full result set is returned in one response.
gorelo_update_contact Pro Write [Gorelo] Update an existing contact. Provide a JSON object body that MUST include contactId (integer — the contact to update; there is NO id in the URL, Gorelo takes it from the body). Updatable fields: firstName, lastName, clientId (integer), clientLocationId (integer), primaryEmail, secondaryEmail (array of strings), mobilePhone, mobilePhoneCountryCode, officePhone, officePhoneCountryCode, jobTitle, department, timeZone, description. Requires an API key with the contacts edit scope.
gorelo_create_contact parameters
Param Type Required Default Description
fieldsJson string yes JSON object body. Required: clientId (integer). Optional: firstName, lastName, clientLocationId (integer), primaryEmail, secondaryEmail (array of strings), mobilePhone, mobilePhoneCountryCode, officePhone, officePhoneCountryCode, jobTitle, department, timeZone, description.
gorelo_get_contact parameters
Param Type Required Default Description
id integer yes The numeric id of the contact (from gorelo_list_contacts).
gorelo_list_contacts parameters
Param Type Required Default Description
clientId integer no null Optional: a numeric client id (from gorelo_list_clients) to return only that client's contacts.
contactIds string no null Optional: a comma-delimited string of numeric contact ids to filter by (e.g. "101,102").
gorelo_update_contact parameters
Param Type Required Default Description
fieldsJson string yes JSON object body. Required: contactId (integer — the contact to update; carried in the body, not the URL). Optional: firstName, lastName, clientId (integer), clientLocationId (integer), primaryEmail, secondaryEmail (array of strings), mobilePhone, mobilePhoneCountryCode, officePhone, officePhoneCountryCode, jobTitle, department, timeZone, description.

Clients

Tool Plan Access Description
gorelo_create_client Pro Write [Gorelo] Create a client (company). Provide a JSON object body. Fields: name, billingName, alternateName, domain, and an optional nested location object { name, phoneCountryCode, phone, phoneExt, address1, address2, city, state, country, postalCode, timeZone }. Requires an API key with the clients edit scope (a 403 means the key lacks it).
gorelo_get_client Free Read-only [Gorelo] Get a single client (company) by its numeric id (from gorelo_list_clients). Returns id, name, statusId, billingName, alternateName, isDefault, and web domains. Requires an API key with the clients read scope.
gorelo_list_client_locations Free Read-only [Gorelo] List the locations (sites) for one client. Provide the numeric clientId (from gorelo_list_clients). Each location carries id, name, address, phone, timeZone, and default flags — use a location id as clientLocationId when creating a contact or ticket. Requires an API key with the clients read scope.
gorelo_list_clients Free Read-only [Gorelo] List all clients (companies) in the Gorelo CRM. Each client carries id, name, statusId, billingName, alternateName, and web domains. Use the returned id with gorelo_get_client, gorelo_list_client_locations, or as clientId when creating contacts/tickets. Requires an API key with the clients read scope (this is also the scope the StackJack Test Connection uses, so a ticket-only key will 403 here). No pagination — the full list returns in one response.
gorelo_update_client Pro Write [Gorelo] Update an existing client (company). Provide a JSON object body that MUST include id (integer — the client to update; there is NO id in the URL, Gorelo takes it from the body). Updatable fields: name, statusId (integer), billingName, alternateName. Requires an API key with the clients edit scope.
gorelo_create_client parameters
Param Type Required Default Description
fieldsJson string yes JSON object body. Fields: name, billingName, alternateName, domain, location (nested object: name, phoneCountryCode, phone, phoneExt, address1, address2, city, state, country, postalCode, timeZone).
gorelo_get_client parameters
Param Type Required Default Description
id integer yes The numeric id of the client (from gorelo_list_clients).
gorelo_list_client_locations parameters
Param Type Required Default Description
clientId integer yes The numeric id of the client whose locations to list (from gorelo_list_clients).
gorelo_update_client parameters
Param Type Required Default Description
fieldsJson string yes JSON object body. Required: id (integer — the client to update; carried in the body, not the URL). Optional: name, statusId (integer), billingName, alternateName.

Assets

Tool Plan Access Description
gorelo_get_agent Free Read-only [Gorelo] Get a single RMM agent device by its UUID id (from gorelo_list_agents). Returns the full device record (OS, hardware, IPs, last-logged-on user, warranty, agent versions, etc.). Requires an API key with the assets read scope.
gorelo_list_agents Free Read-only [Gorelo] List all RMM agent devices. Each agent carries a UUID id, name/displayName, statusId, client/location, OS and hardware details, IP addresses, last-boot / last-logged-on-user, and agent version fields. Use the returned UUID with gorelo_get_agent or as an agentAssetId when creating a ticket. Requires an API key with the assets read scope. No pagination — the full list returns in one response.
gorelo_get_agent parameters
Param Type Required Default Description
id string yes The UUID id of the agent device (from gorelo_list_agents).

Alerts

Tool Plan Access Description
gorelo_create_alert Pro Write [Gorelo] Raise an alert for a client. Provide a JSON object body. Fields: clientId (integer, required — the owning client from gorelo_list_clients), name, resource (the affected resource string), severity (integer 1-4 — the alert level; the vendor spec does not label the levels), description. The endpoint returns HTTP 200 with an empty body on success (surfaced as ). Note: the public API has no alert list or get endpoint — this is a create-only surface. Requires an API key with the alerts edit scope (a 403 means the key lacks it).
gorelo_create_alert parameters
Param Type Required Default Description
fieldsJson string yes JSON object body. Required: clientId (integer), severity (integer 1-4). Optional: name, resource, description.

Tickets

Tool Plan Access Description
gorelo_create_ticket Pro Write [Gorelo] Create a PSA ticket. Provide a JSON object body. Common fields: title, description, clientId (integer, from gorelo_list_clients), locationId (integer), contactId (integer), groupId (integer, required — the owning team/group), typeId (integer, from gorelo_list_ticket_types), statusId (integer, from gorelo_list_ticket_statuses), priorityId (integer 0-4), sourceId (integer 1-6 — the ticket origin), tagIds (array of integers, from gorelo_list_ticket_tags), ccContactIds / watcherIds / assistingAssigneeIds (arrays of integers), leadAssigneeId (integer), agentAssetIds / customAssetIds / uptimeIds (arrays of UUIDs), createdByName, sendTicketCreatedEmail (bool), isUnread (bool). Returns . IMPORTANT: the public API has NO ticket list or get-by-id endpoint, so the created ticket cannot be read back through this connector. Requires an API key with the tickets edit scope.
gorelo_list_ticket_statuses Free Read-only [Gorelo] List the configured ticket statuses (id, name, baseStatusId, color, sortOrder, description). Use a status id as statusId when creating a ticket with gorelo_create_ticket. Requires an API key with the tickets read scope. No pagination.
gorelo_list_ticket_tags Free Read-only [Gorelo] List the configured ticket tags (id, name, description, isAiTag). Use tag ids in the tagIds array when creating a ticket with gorelo_create_ticket. Requires an API key with the tickets read scope. No pagination.
gorelo_list_ticket_types Free Read-only [Gorelo] List the configured ticket types (id, name, description, isAiType). Use a type id as typeId when creating a ticket with gorelo_create_ticket. Requires an API key with the tickets read scope. No pagination.
gorelo_create_ticket parameters
Param Type Required Default Description
fieldsJson string yes JSON object body. Common fields: title, description, clientId (int), locationId (int), contactId (int), groupId (int — owning group), typeId (int), statusId (int), priorityId (int 0-4), sourceId (int 1-6), tagIds (int[]), ccContactIds/watcherIds/assistingAssigneeIds (int[]), leadAssigneeId (int), agentAssetIds/customAssetIds/uptimeIds (uuid[]), createdByName, sendTicketCreatedEmail (bool), isUnread (bool). Returns .

Organization

Tool Plan Access Description
gorelo_list_organization_groups Free Read-only [Gorelo] List the groups (teams) in your Gorelo organization. Useful for resolving the groupId required when creating a ticket with gorelo_create_ticket. The public spec declares no response schema, so the raw JSON is returned verbatim. Requires an API key with the organization read scope. No pagination.
gorelo_list_organization_users Free Read-only [Gorelo] List the users in your Gorelo organization (your MSP's technicians/staff, not client contacts). Useful for resolving assignee ids used when creating a ticket (leadAssigneeId, assistingAssigneeIds, watcherIds). The public spec declares no response schema, so the raw JSON is returned verbatim. Requires an API key with the organization read scope. No pagination.