highrise: appmixer.highrise.core.MakeApiCall

Basic Information

Name

appmixer.highrise.core.MakeApiCall

Version

1.0.0

Visibility

Public

Description

Performs an arbitrary authorized API call to the Highrise API.

Input Ports

in

Field	Type	Description
Account Subdomain	text	Your Highrise account subdomain, i.e. the `{companyId}` in `https://{companyId}.highrisehq.com`. Used to build the instance-specific base URL.
API Endpoint Path	text	Enter the API endpoint path relative to `https://{companyId}.highrisehq.com` (for example `/people.json`) or provide a full URL.
HTTP Method	select	Select the HTTP method for the API call.
Query Parameters	key-value	Optional query parameters.
Request Body	textarea	Enter the request body as a JSON object (supports nested objects, arrays, and non-string values).
Request Headers	key-value	Optional additional request headers.

Output Ports

out

Field	Type	Description
Status Code		-
Response Headers		-
Response Body		-

Full Metadata

#metadata-viewer { display: none; }{ "name": "appmixer.highrise.core.MakeApiCall", "author": "Appmixer <info@appmixer.com>", "description": "Performs an arbitrary authorized API call to the Highrise API.", "version": "1.0.0", "private": false, "auth": { "service": "appmixer:highrise" }, "quota": { "manager": "appmixer:highrise", "resources": "requests", "scope": { "userId": "{{userId}}" } }, "inPorts": [ { "name": "in", "schema": { "type": "object", "properties": { "companyId": { "type": "string" }, "url": { "type": "string" }, "method": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] }, "headers": { "type": "string" }, "parameters": { "type": "string" }, "body": { "type": "string" } }, "required": [ "companyId", "url", "method" ] }, "inspector": { "inputs": { "companyId": { "type": "text", "index": 0, "label": "Account Subdomain", "tooltip": "Your Highrise account subdomain, i.e. the <code>{companyId}</code> in <code>https://{companyId}.highrisehq.com</code>. Used to build the instance-specific base URL." }, "url": { "type": "text", "index": 1, "label": "API Endpoint Path", "tooltip": "Enter the API endpoint path relative to <code>https://{companyId}.highrisehq.com</code> (for example <code>/people.json</code>) or provide a full URL." }, "method": { "type": "select", "index": 2, "label": "HTTP Method", "defaultValue": "GET", "tooltip": "Select the HTTP method for the API call.", "options": [ { "label": "GET", "value": "GET" }, { "label": "POST", "value": "POST" }, { "label": "PUT", "value": "PUT" }, { "label": "PATCH", "value": "PATCH" }, { "label": "DELETE", "value": "DELETE" } ] }, "parameters": { "type": "key-value", "keyLabel": "Key", "valueLabel": "Value", "addLabel": "Add item", "removeLabel": "Remove item", "label": "Query Parameters", "index": 3, "tooltip": "Optional query parameters." }, "body": { "type": "textarea", "index": 4, "label": "Request Body", "tooltip": "Enter the request body as a JSON object (supports nested objects, arrays, and non-string values)." }, "headers": { "type": "key-value", "keyLabel": "Key", "valueLabel": "Value", "addLabel": "Add item", "removeLabel": "Remove item", "label": "Request Headers", "index": 5, "tooltip": "Optional additional request headers." } } } } ], "outPorts": [ { "name": "out", "options": [ { "label": "Status Code", "value": "status" }, { "label": "Response Headers", "value": "headers" }, { "label": "Response Body", "value": "body", "schema": { "type": "object", "properties": {} } } ] } ], "icon": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0Ij4KICA8ZyBpZD0iR3JvdXBfNTExIiBkYXRhLW5hbWU9Ikdyb3VwIDUxMSIgdHJhbnNmb3JtPSJ0cmFuc2xhdGUoLTM0NSAtMjIpIj4KICAgIDxyZWN0IGlkPSJSZWN0YW5nbGVfMzM1MiIgZGF0YS1uYW1lPSJSZWN0YW5nbGUgMzM1MiIgd2lkdGg9IjI0IiBoZWlnaHQ9IjI0IiB0cmFuc2Zvcm09InRyYW5zbGF0ZSgzNDUgMjIpIiBmaWxsPSJub25lIi8+CiAgICA8ZyBpZD0iR3JvdXBfNTEwIiBkYXRhLW5hbWU9Ikdyb3VwIDUxMCIgdHJhbnNmb3JtPSJ0cmFuc2xhdGUoLTUwLjA3IC0yODYpIj4KICAgICAgPHBhdGggaWQ9IlBhdGhfMjA1IiBkYXRhLW5hbWU9IlBhdGggMjA1IiBkPSJNMjguMywyMy44MTZjNS43MjMsMCw4LjkyNC0yLjI0OCw5Ljc3NS00LjExN0MzNy44NCwxNS4yODMsMzMuOTM3LDcuMjEsMjguMjE0LDcuMjFTMTguNjI2LDEzLjk1NywxOC4wNywxOS43QzE5LjA5NSwyMi4wNDksMjIuNTYzLDIzLjgxNiwyOC4zLDIzLjgxNloiIHRyYW5zZm9ybT0idHJhbnNsYXRlKDM3OSAzMDMuNzkpIiBmaWxsPSIjYWZkY2Y2Ii8+CiAgICAgIDxwYXRoIGlkPSJQYXRoXzIwNiIgZGF0YS1uYW1lPSJQYXRoIDIwNiIgZD0iTTMxLjEsNDIuODQ0YzQuNzk0LDAsNy42MzUtMS4zNjYsOC42MS0zLjI0MiwwLTEuMjgyLTMuODcyLTIuODIzLTguNjQyLTIuODIzcy04LjY0MiwxLjQtOC42NDIsMi44MjNDMjMuMjkzLDQxLjQsMjYuMzMzLDQyLjg0NCwzMS4xLDQyLjg0NFoiIHRyYW5zZm9ybT0idHJhbnNsYXRlKDM3NS45OTQgMjgzLjQwMikiIGZpbGw9IiM0MWI3NmIiLz4KICAgICAgPHBhdGggaWQ9IlBhdGhfMjA3IiBkYXRhLW5hbWU9IlBhdGggMjA3IiBkPSJNMzguMTIsMjguMzZsMi4wNjgtLjc3M3Y0LjU0OWwtMi4wNjguNzczWm03LjQxNS0yLjAyNUw0Ny42LDI1LjgyVjMxLjlsLTIuMDY4LjlaIiB0cmFuc2Zvcm09InRyYW5zbGF0ZSgzNjUuMTc2IDI5MC45NTkpIiBmaWxsPSIjYThhMzgyIi8+CiAgICAgIDxwYXRoIGlkPSJQYXRoXzIwOCIgZGF0YS1uYW1lPSJQYXRoIDIwOCIgZD0iTTU3Ljg2MywyNS4xNzdsMi4wNjgtLjUxNS0yLjA2OC0uNTIyTDU2LDI0LjYxMloiIHRyYW5zZm9ybT0idHJhbnNsYXRlKDM1Mi44NDggMjkyLjExNykiIGZpbGw9IiNmOGYyYzgiLz4KICAgICAgPHBhdGggaWQ9IlBhdGhfMjA5IiBkYXRhLW5hbWU9IlBhdGggMjA5IiBkPSJNNDEuMTI5LDI2LjIzMmwtMS44LS41NjJ2Ni4zNjVsMS44LjY0M1ptLTcuNDE1LDIuMDI1TDMxLjczLDI2LjM5M1YzMS43NWwxLjk4NCwxLjAzN1oiIHRyYW5zZm9ybT0idHJhbnNsYXRlKDM2OS41ODIgMjkxLjA2MikiIGZpbGw9IiNjYWM1OWQiLz4KICAgICAgPHBhdGggaWQ9IlBhdGhfMjEwIiBkYXRhLW5hbWU9IlBhdGggMjEwIiBkPSJNMzMuNzE0LDI4LjA2NGwyLjA2OC0uNzczLTIuMDI1LTEuOS0yLjAyOC44MVoiIHRyYW5zZm9ybT0idHJhbnNsYXRlKDM2OS41ODIgMjkxLjI1NSkiIGZpbGw9IiNmOGYyYzgiLz4KICAgICAgPHBhdGggaWQ9IlBhdGhfMjExIiBkYXRhLW5hbWU9IlBhdGggMjExIiBkPSJNNTAsMjAuMzE5bDIuNDUtLjYuNTYyLDkuMjQxLTIuOTc4LDEuMDkzWiIgdHJhbnNmb3JtPSJ0cmFuc2xhdGUoMzU2Ljk4NSAyOTUuMTY1KSIgZmlsbD0iIzVlOThiMCIvPgogICAgICA8cGF0aCBpZD0iUGF0aF8yMTIiIGRhdGEtbmFtZT0iUGF0aCAyMTIiIGQ9Ik00My40NzEsMjAuMzE5bC0yLjQtLjYtLjU0Myw5LjI0MSwzLDEuMDkzWiIgdHJhbnNmb3JtPSJ0cmFuc2xhdGUoMzYzLjUxNCAyOTUuMTY1KSIgZmlsbD0iIzg4YzZkZSIvPgogICAgICA8cGF0aCBpZD0iUGF0aF8yMTMiIGRhdGEtbmFtZT0iUGF0aCAyMTMiIGQ9Ik00NC42NzcsMTguODQ0bC0yLjQtLjYsMi40LS42NjQsMi40NS42NjRaIiB0cmFuc2Zvcm09InRyYW5zbGF0ZSgzNjIuMzA3IDI5Ni42NCkiIGZpbGw9IiNkZmYzZmQiIG9wYWNpdHk9IjAuOSIgc3R5bGU9Imlzb2xhdGlvbjogaXNvbGF0ZSIvPgogICAgICA8cGF0aCBpZD0iUGF0aF8yMTQiIGRhdGEtbmFtZT0iUGF0aCAyMTQiIGQ9Ik00Ny44MjMsMTYuNzgzaDBhLjEzLjEzLDAsMCwxLC4xMjcuMTN2LjlhLjEzLjEzLDAsMCwxLS4xMy4xM2gwYS4xMy4xMywwLDAsMS0uMTMtLjEzdi0uOWEuMTMuMTMsMCwwLDEsLjEzLS4xMzRaIiB0cmFuc2Zvcm09InRyYW5zbGF0ZSgzNTguNTc3IDI5Ny4xOTIpIiBmaWxsPSIjNWU5OGIwIi8+CiAgICAgIDxwYXRoIGlkPSJQYXRoXzIxNSIgZGF0YS1uYW1lPSJQYXRoIDIxNSIgZD0iTTQ4LjAyMywxMi43NWgwYS4wNDMuMDQzLDAsMCwxLC4wNDMuMDQzdjEuOTQxYS4wNDMuMDQzLDAsMCwxLS4wNDMuMDQzaDBhLjA0My4wNDMsMCwwLDEtLjA0My0uMDQzVjEyLjhhLjA0My4wNDMsMCwwLDEsLjAzNC0uMDQ3WiIgdHJhbnNmb3JtPSJ0cmFuc2xhdGUoMzU4LjM3OCAyOTkuOTcpIiBmaWxsPSIjNWU5OGIwIi8+CiAgICAgIDxwYXRoIGlkPSJQYXRoXzIxNiIgZGF0YS1uYW1lPSJQYXRoIDIxNiIgZD0iTTUxLjcxLDE1LjEzaDBhLjEzLjEzLDAsMCwxLC4xMy4xM3YuOWEuMTMuMTMsMCwwLDEtLjEzLjEzaDBhLjEzLjEzLDAsMCwxLS4xMy0uMTN2LS45MUEuMTMuMTMsMCwwLDEsNTEuNzEsMTUuMTNaIiB0cmFuc2Zvcm09InRyYW5zbGF0ZSgzNTUuODk1IDI5OC4zMjkpIiBmaWxsPSIjNWU5OGIwIi8+CiAgICAgIDxwYXRoIGlkPSJQYXRoXzIxNyIgZGF0YS1uYW1lPSJQYXRoIDIxNyIgZD0iTTUxLjksMTEuMDloMGEuMDQzLjA0MywwLDAsMSwuMDQzLjA0M3YxLjk0MWEuMDQzLjA0MywwLDAsMS0uMDQzLjA0M2gwYS4wNDMuMDQzLDAsMCwxLS4wNDMtLjA0M1YxMS4xMzNBLjA0My4wNDMsMCwwLDEsNTEuOSwxMS4wOVoiIHRyYW5zZm9ybT0idHJhbnNsYXRlKDM1NS43MDIgMzAxLjExNSkiIGZpbGw9IiM1ZTk4YjAiLz4KICAgIDwvZz4KICA8L2c+Cjwvc3ZnPgo=" }