helpscout: appmixer.helpscout.core.GetCustomer

Basic Information

Name

appmixer.helpscout.core.GetCustomer

Version

1.0.0

Visibility

Public

Description

Retrieve a single customer by ID.

Input Ports

in

Field	Type	Description
Customer ID	text	Customer ID.

Output Ports

out

Field	Type	Description
Customer ID		-
First Name		-
Last Name		-
Gender		-
Job Title		-
Location		-
Organization		-
Organization ID		-
Photo Type		-
Photo Url		-
Age		-
Created At		-
Updated At		-
Background		-
Draft		-
Embedded		-
Links		-

Full Metadata

#metadata-viewer { display: none; }{ "name": "appmixer.helpscout.core.GetCustomer", "author": "Appmixer <info@appmixer.com>", "description": "Retrieve a single customer by ID.", "version": "1.0.0", "private": false, "auth": { "service": "appmixer:helpscout" }, "quota": { "manager": "appmixer:helpscout", "resources": "requests" }, "inPorts": [ { "name": "in", "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] }, "inspector": { "inputs": { "id": { "type": "text", "tooltip": "Customer ID.", "label": "Customer ID", "index": 0 } } } } ], "outPorts": [ { "name": "out", "options": [ { "label": "Customer ID", "value": "id", "schema": { "type": "number", "example": 12345 } }, { "label": "First Name", "value": "firstName", "schema": { "type": "string", "example": "John" } }, { "label": "Last Name", "value": "lastName", "schema": { "type": "string", "example": "Doe" } }, { "label": "Gender", "value": "gender", "schema": { "type": "string", "example": "male" } }, { "label": "Job Title", "value": "jobTitle", "schema": { "type": "string", "example": "Software Engineer" } }, { "label": "Location", "value": "location", "schema": { "type": "string", "example": "New York, NY" } }, { "label": "Organization", "value": "organization", "schema": { "type": "string", "example": "Acme Corp" } }, { "label": "Organization ID", "value": "organizationId", "schema": { "type": "number", "example": 200 } }, { "label": "Photo Type", "value": "photoType", "schema": { "type": "string", "example": "gravatar" } }, { "label": "Photo Url", "value": "photoUrl", "schema": { "type": "string", "example": "https://example.com/photos/user123.jpg" } }, { "label": "Age", "value": "age", "schema": { "type": "string", "example": "35" } }, { "label": "Created At", "value": "createdAt", "schema": { "type": "string", "example": "2024-01-15T10:30:00Z" } }, { "label": "Updated At", "value": "updatedAt", "schema": { "type": "string", "example": "2024-01-16T14:20:00Z" } }, { "label": "Background", "value": "background", "schema": { "type": "string", "example": "Frequent customer since 2020" } }, { "label": "Draft", "value": "draft", "schema": { "type": "boolean", "example": false } }, { "label": "Embedded", "value": "_embedded", "schema": { "type": "object", "properties": { "emails": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number", "title": "Embedded.Emails.ID" }, "value": { "type": "string", "title": "Embedded.Emails.Value" }, "type": { "type": "string", "title": "Embedded.Emails.Type" } } }, "title": "Embedded.Emails" }, "phones": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number", "title": "Embedded.Phones.ID" }, "value": { "type": "string", "title": "Embedded.Phones.Value" }, "type": { "type": "string", "title": "Embedded.Phones.Type" } } }, "title": "Embedded.Phones" }, "chats": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number", "title": "Embedded.Chats.ID" }, "value": { "type": "string", "title": "Embedded.Chats.Value" }, "type": { "type": "string", "title": "Embedded.Chats.Type" } } }, "title": "Embedded.Chats" }, "social_profiles": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number", "title": "Embedded.Social Profiles.ID" }, "value": { "type": "string", "title": "Embedded.Social Profiles.Value" }, "type": { "type": "string", "title": "Embedded.Social Profiles.Type" } } }, "title": "Embedded.Social Profiles" }, "websites": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number", "title": "Embedded.Websites.ID" }, "value": { "type": "string", "title": "Embedded.Websites.Value" } } }, "title": "Embedded.Websites" }, "properties": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "title": "Embedded.Properties.Type" }, "slug": { "type": "string", "title": "Embedded.Properties.Slug" }, "name": { "type": "string", "title": "Embedded.Properties.Name" }, "value": { "type": "string", "title": "Embedded.Properties.Value" }, "text": { "type": "string", "title": "Embedded.Properties.Text" }, "source": { "type": "object", "properties": { "name": { "type": "string", "title": "Embedded.Properties.Source.Name" } }, "title": "Embedded.Properties.Source" } } }, "title": "Embedded.Properties" }, "address": { "type": "object", "properties": { "city": { "type": "string", "title": "Embedded.Address.City", "example": "New York" }, "lines": { "type": "array", "items": {}, "title": "Embedded.Address.Lines" } }, "title": "Embedded.Address" } } } }, { "label": "Links", "value": "_links", "schema": { "type": "object", "properties": { "address": { "type": "object", "properties": { "href": { "type": "string", "title": "Links.Address.Href", "example": "https://api.example.com/customers/789/address" } }, "title": "Links.Address" }, "chats": { "type": "object", "properties": { "href": { "type": "string", "title": "Links.Chats.Href", "example": "https://api.example.com/customers/789/chats" } }, "title": "Links.Chats" }, "emails": { "type": "object", "properties": { "href": { "type": "string", "title": "Links.Emails.Href", "example": "https://api.example.com/customers/789/emails" } }, "title": "Links.Emails" }, "phones": { "type": "object", "properties": { "href": { "type": "string", "title": "Links.Phones.Href", "example": "https://api.example.com/customers/789/phones" } }, "title": "Links.Phones" }, "social-profiles": { "type": "object", "properties": { "href": { "type": "string", "title": "Links.Social-Profiles.Href", "example": "https://api.example.com/customers/789/social-profiles" } }, "title": "Links.Social-Profiles" }, "websites": { "type": "object", "properties": { "href": { "type": "string", "title": "Links.Websites.Href", "example": "https://app.example.com/conversations/123" } }, "title": "Links.Websites" }, "organization": { "type": "object", "properties": { "href": { "type": "string", "title": "Links.Organization.Href", "example": "https://api.example.com/organizations/200" } }, "title": "Links.Organization" }, "self": { "type": "object", "properties": { "href": { "type": "string", "title": "Links.Self.Href", "example": "https://api.example.com/resource/123" } }, "title": "Links.Self" } } } } ] } ], "icon": "data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPCEtLSBVcGxvYWRlZCB0bzogU1ZHIFJlcG8sIHd3dy5zdmdyZXBvLmNvbSwgR2VuZXJhdG9yOiBTVkcgUmVwbyBNaXhlciBUb29scyAtLT4KPHN2ZyB3aWR0aD0iODAwcHgiIGhlaWdodD0iODAwcHgiIHZpZXdCb3g9Ii0yNyAwIDMxMCAzMTAiIHZlcnNpb249IjEuMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgcHJlc2VydmVBc3BlY3RSYXRpbz0ieE1pZFlNaWQiPgogICAgPGc+CiAgICAgICAgPHBhdGggZD0iTTE4LjQzMiwxODAuOTY4NzI3IEwxMDguOTE2MzY0LDkwLjQ4NDM2MzYgQzEyMC42NDU4MTgsNzguOTQxMDkwOSAxMjcuOTA2OTA5LDYyLjc0MzI3MjcgMTI3LjkwNjkwOSw0NS4wNTYgQzEyNy45MDY5MDksMjcuNTU0OTA5MSAxMjAuODMyLDExLjU0MzI3MjcgMTA5LjQ3NDkwOSwwIEwxOC45OTA1NDU1LDkwLjQ4NDM2MzYgQzcuMjYxMDkwOTEsMTAyLjAyNzYzNiAwLDExOC4yMjU0NTUgMCwxMzUuOTEyNzI3IEMwLDE1My42IDcuMDc0OTA5MDksMTY5LjQyNTQ1NSAxOC40MzIsMTgwLjk2ODcyNyBaIE0yMzcuNTY4LDEyOC4wOTMwOTEgTDE0Ny4wODM2MzYsMjE4LjU3NzQ1NSBDMTM1LjM1NDE4MiwyMzAuMTIwNzI3IDEyOC4wOTMwOTEsMjQ2LjMxODU0NSAxMjguMDkzMDkxLDI2NC4wMDU4MTggQzEyOC4wOTMwOTEsMjgxLjUwNjkwOSAxMzUuMTY4LDI5Ny41MTg1NDUgMTQ2LjUyNTA5MSwzMDkuMDYxODE4IEwyMzcuMDA5NDU1LDIxOC41Nzc0NTUgQzI0OC43Mzg5MDksMjA3LjAzNDE4MiAyNTYsMTkwLjgzNjM2NCAyNTYsMTczLjE0OTA5MSBDMjU2LDE1NS40NjE4MTggMjQ4LjkyNTA5MSwxMzkuNjM2MzY0IDIzNy41NjgsMTI4LjA5MzA5MSBaIE0yMzcuMDA5NDU1LDkwLjY3MDU0NTUgQzI0OC43Mzg5MDksNzkuMTI3MjcyNyAyNTYsNjIuOTI5NDU0NSAyNTYsNDUuMjQyMTgxOCBDMjU2LDI3Ljc0MTA5MDkgMjQ4LjkyNTA5MSwxMS43Mjk0NTQ1IDIzNy41NjgsMC4xODYxODE4MTggTDE4Ljk5MDU0NTUsMjE4LjU3NzQ1NSBDNy4yNjEwOTA5MSwyMzAuMzA2OTA5IDAsMjQ2LjMxODU0NSAwLDI2NC4xOTIgQzAsMjgxLjY5MzA5MSA3LjA3NDkwOTA5LDI5Ny43MDQ3MjcgMTguNDMyLDMwOS4yNDggTDIzNy4wMDk0NTUsOTAuNjcwNTQ1NSBaIiBmaWxsPSIjMTI5MkVFIj4KDTwvcGF0aD4KICAgIDwvZz4KPC9zdmc+" }