Skip to content
Changelog

Report a bug

Help Scout integration: operations for AI agents

Help Scout connects to Type.com as an integration. This page lists the 148 operations documented for Claude and Codex in Type.com: 82 read, 32 write, 34 destructive.

About Help Scout

Help Scout Mailbox vendor API references, subject to vendor permissions and account availability.

Categories: Customer Support

How to connect Help Scout to Type.com

Connect
Managed OAuth through Pipedream when enabled for your workspace
Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

148 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

148 operations listed.

Conversations

  • Read

    List Conversations

    List Conversations

    GET /v2/conversations

  • Read

    Download Attachment File

    Download Attachment File

    GET /v2/conversations/{conversationId}/attachments/{attachmentId}/file

  • Read

    Get Attachment Data

    Get Attachment Data

    GET /v2/conversations/{conversationId}/attachments/{attachmentId}/data

  • Read

    Get Thread Original Source

    Get Thread Original Source

    GET /v2/conversations/{conversationId}/threads/{threadId}/original-source

  • Read

    Get Thread Original Source (RFC 822)

    Get Thread Original Source (RFC 822)

    GET /v2/conversations/{conversationId}/threads/{threadId}/original-source

  • Read

    List Threads

    List Threads

    GET /v2/conversations/{conversationId}/threads

  • Read

    List Threads (v3)

    List Threads (v3)

    GET /v3/conversations/{conversationId}/threads

  • Read

    Get Conversation

    Get Conversation

    GET /v2/conversations/{conversationId}

  • Read

    Get Conversation (v3)

    Get Conversation (v3)

    GET /v3/conversations/{conversationId}

  • Read

    List Conversations (v3)

    List Conversations (v3)

    GET /v3/conversations

  • Read

    Search Conversations (v3)

    Search Conversations (v3)

    GET /v3/conversations/search

  • Write

    Upload Attachment

    Upload Attachment

    POST /v2/conversations/{conversationId}/threads/{threadId}/attachments

  • Write

    Publish Thread Schedule

    Publish Thread Schedule

    PATCH /v2/conversations/{conversationId}/threads/{threadId}/schedule

  • Write

    Update Thread Schedule

    Update Thread Schedule

    PUT /v2/conversations/{conversationId}/threads/{threadId}/schedule

  • Write

    Create Chat Thread

    Create Chat Thread

    POST /v2/conversations/{conversationId}/chats

  • Write

    Create Customer Thread

    Create Customer Thread

    POST /v2/conversations/{conversationId}/customer

  • Write

    Create Note

    Create Note

    POST /v2/conversations/{conversationId}/notes

  • Write

    Create Phone Thread

    Create Phone Thread

    POST /v2/conversations/{conversationId}/phones

  • Write

    Create Reply Thread

    Create Reply Thread

    POST /v2/conversations/{conversationId}/reply

  • Write

    Create Conversation

    Create Conversation

    POST /v2/conversations

  • Destructive

    Delete Attachment

    Delete Attachment

    DELETE /v2/conversations/{conversationId}/attachments/{attachmentId}

  • Destructive

    Update Custom Fields

    Update Custom Fields

    PUT /v2/conversations/{conversationId}/fields

  • Destructive

    Delete Snooze

    Delete Snooze

    DELETE /v2/conversations/{conversationId}/snooze

  • Destructive

    Update Snooze

    Update Snooze

    PUT /v2/conversations/{conversationId}/snooze

  • Destructive

    Update Tags

    Update Tags

    PUT /v2/conversations/{conversationId}/tags

  • Destructive

    Delete Thread Schedule

    Delete Thread Schedule

    DELETE /v2/conversations/{conversationId}/threads/{threadId}/schedule

  • Destructive

    Update Thread

    Update Thread

    PATCH /v2/conversations/{conversationId}/threads/{threadId}

  • Destructive

    Delete Conversation

    Delete Conversation

    DELETE /v2/conversations/{conversationId}

  • Destructive

    Update Conversation

    Update Conversation

    PATCH /v2/conversations/{conversationId}

Customers

  • Read

    List Customers

    List Customers

    GET /v2/customers

  • Read

    Get Address

    Get Address

    GET /v2/customers/{customerId}/address

  • Read

    List Chats Handles

    List Chats Handles

    GET /v2/customers/{customerId}/chats

  • Read

    List Emails

    List Emails

    GET /v2/customers/{customerId}/emails

  • Read

    List Phones

    List Phones

    GET /v2/customers/{customerId}/phones

  • Read

    List Social Profiles

    List Social Profiles

    GET /v2/customers/{customerId}/social-profiles

  • Read

    List Websites

    List Websites

    GET /v2/customers/{customerId}/websites

  • Read

    Get Customer

    Get Customer

    GET /v2/customers/{customerId}

  • Read

    List Customers (v3)

    List Customers (v3)

    GET /v3/customers

  • Write

    Create Address

    Create Address

    POST /v2/customers/{customerId}/address

  • Write

    Update Address

    Update Address

    PUT /v2/customers/{customerId}/address

  • Write

    Create Chat Handle

    Create Chat Handle

    POST /v2/customers/{customerId}/chats

  • Write

    Update Chat Handles

    Update Chat Handles

    PUT /v2/customers/{customerId}/chats/{chatId}

  • Write

    Create Email

    Create Email

    POST /v2/customers/{customerId}/emails

  • Write

    Update Email

    Update Email

    PUT /v2/customers/{customerId}/emails/{emailId}

  • Write

    Create Phone

    Create Phone

    POST /v2/customers/{customerId}/phones

  • Write

    Update Phone

    Update Phone

    PUT /v2/customers/{customerId}/phones/{phoneId}

  • Write

    Create Social Profile

    Create Social Profile

    POST /v2/customers/{customerId}/social-profiles

  • Write

    Update Social Profile

    Update Social Profile

    PUT /v2/customers/{customerId}/social-profiles/{socialProfileId}

  • Write

    Create Website

    Create Website

    POST /v2/customers/{customerId}/websites

  • Write

    Update Website

    Update Website

    PUT /v2/customers/{customerId}/websites/{websiteId}

  • Write

    Create Customer

    Create Customer

    POST /v2/customers

  • Destructive

    Delete Address

    Delete Address

    DELETE /v2/customers/{customerId}/address

  • Destructive

    Delete Chat Handle

    Delete Chat Handle

    DELETE /v2/customers/{customerId}/chats/{chatId}

  • Destructive

    Delete Email

    Delete Email

    DELETE /v2/customers/{customerId}/emails/{emailId}

  • Destructive

    Delete Phone

    Delete Phone

    DELETE /v2/customers/{customerId}/phones/{phoneId}

  • Destructive

    Delete Social Profile

    Delete Social Profile

    DELETE /v2/customers/{customerId}/social-profiles/{socialProfileId}

  • Destructive

    Delete Website

    Delete Website

    DELETE /v2/customers/{customerId}/websites/{websiteId}

  • Destructive

    Delete Customer

    Delete Customer

    DELETE /v2/customers/{customerId}

  • Destructive

    Delete Customer Asynchronously

    Delete Customer Asynchronously

    DELETE /v2/customers/{customerId}

  • Destructive

    Overwrite Customer

    Overwrite Customer

    PUT /v2/customers/{customerId}

  • Destructive

    Update Customer

    Update Customer

    PATCH /v2/customers/{customerId}

Inboxes

  • Read

    Get Routing configuration

    Get Routing configuration

    GET /v2/mailboxes/{mailboxId}/routing

  • Read

    Get Saved Reply

    Get Saved Reply

    GET /v2/mailboxes/{mailboxId}/saved-replies/{savedReplyId}

  • Read

    List Saved Replies

    List Saved Replies

    GET /v2/mailboxes/{mailboxId}/saved-replies

  • Read

    Get Inbox

    Get Inbox

    GET /v2/mailboxes/{mailboxId}

  • Read

    List Inbox Custom Fields

    List Inbox Custom Fields

    GET /v2/mailboxes/{mailboxId}/fields

  • Read

    List Inbox Folders

    List Inbox Folders

    GET /v2/mailboxes/{mailboxId}/folders

  • Read

    List Inboxes

    List Inboxes

    GET /v2/mailboxes

  • Write

    Create Saved Reply

    Create Saved Reply

    POST /v2/mailboxes/{mailboxId}/saved-replies

  • Write

    Update Saved Reply

    Update Saved Reply

    PUT /v2/mailboxes/{mailboxId}/saved-replies/{savedReplyId}

  • Destructive

    Update Routing configuration

    Update Routing configuration

    PUT /v2/mailboxes/{mailboxId}/routing

  • Destructive

    Delete Saved Reply

    Delete Saved Reply

    DELETE /v2/mailboxes/{mailboxId}/saved-replies/{savedReplyId}

Organizations

  • Read

    Get Organization by ID

    Get Organization by ID

    GET /v2/organizations/{organizationId}

  • Read

    Get Organization Property Definition

    Get Organization Property Definition

    GET /v2/organizations/properties/{slug}

  • Read

    List Organization Property Definitions

    List Organization Property Definitions

    GET /v2/organizations/properties

  • Read

    Get Organization Conversations

    Get Organization Conversations

    GET /v2/organizations/{organizationId}/conversations

  • Read

    Get Organization Customers

    Get Organization Customers

    GET /v2/organizations/{organizationId}/customers

  • Read

    List Organizations

    List Organizations

    GET /v2/organizations

  • Write

    Create Organization Property Definition

    Create Organization Property Definition

    POST /v2/organizations/properties

  • Write

    Create Organization

    Create Organization

    POST /v2/organizations

  • Destructive

    Delete Organization Property Definition

    Delete Organization Property Definition

    DELETE /v2/organizations/properties/{slug}

  • Destructive

    Remove Organization Property Value

    Remove Organization Property Value

    DELETE /v2/organizations/{organizationId}/properties/{slug}

  • Destructive

    Set Organization Property Value

    Set Organization Property Value

    PUT /v2/organizations/{organizationId}/properties/{slug}

  • Destructive

    Update Organization Property Definition

    Update Organization Property Definition

    PUT /v2/organizations/properties/{slug}

  • Destructive

    Delete Organization by ID

    Delete Organization by ID

    DELETE /v2/organizations/{organizationId}

  • Destructive

    Update Organization

    Update Organization

    PUT /v2/organizations/{organizationId}

Properties

  • Read

    List Customer Property Definitions

    List Customer Property Definitions

    GET /v2/customer-properties

  • Write

    Create Customer Property Definition

    Create Customer Property Definition

    POST /v2/customer-properties

  • Destructive

    Delete Customer Property Definition

    Delete Customer Property Definition

    DELETE /v2/customer-properties/{slug}

  • Destructive

    Update Customer Properties

    Update Customer Properties

    PATCH /v2/customers/{customerId}/properties

Ratings

  • Read

    Get Satisfaction Rating

    Get Satisfaction Rating

    GET /v2/ratings/{ratingId}

Reports

  • Read

    Company Overall Report

    Company Overall Report

    GET /v2/reports/company

  • Read

    Company Customers Helped

    Company Customers Helped

    GET /v2/reports/company/customers-helped

  • Read

    Company Drilldown

    Company Drilldown

    GET /v2/reports/company/drilldown

  • Read

    Conversations - Overall Report

    Conversations - Overall Report

    GET /v2/reports/conversations

  • Read

    All Channels - Volumes by Channel

    All Channels - Volumes by Channel

    GET /v2/reports/conversations/volume-by-channel

  • Read

    Conversations - Busiest Time of Day

    Conversations - Busiest Time of Day

    GET /v2/reports/conversations/busy-times

  • Read

    Conversations - Drilldown

    Conversations - Drilldown

    GET /v2/reports/conversations/drilldown

  • Read

    Conversations - Drilldown by Field

    Conversations - Drilldown by Field

    GET /v2/reports/conversations/fields-drilldown

  • Read

    Conversations - New Conversations

    Conversations - New Conversations

    GET /v2/reports/conversations/new

  • Read

    Conversations - New Conversations Drilldown

    Conversations - New Conversations Drilldown

    GET /v2/reports/conversations/new-drilldown

  • Read

    Conversations - Received Messages Statistics

    Conversations - Received Messages Statistics

    GET /v2/reports/conversations/received-messages

  • Read

    Docs Overall Report

    Docs Overall Report

    GET /v2/reports/docs

  • Read

    Happiness Overall Report

    Happiness Overall Report

    GET /v2/reports/happiness

  • Read

    Happiness Ratings Report

    Happiness Ratings Report

    GET /v2/reports/happiness/ratings

  • Read

    Productivity Overall Report

    Productivity Overall Report

    GET /v2/reports/productivity

  • Read

    Productivity - First Response Time

    Productivity - First Response Time

    GET /v2/reports/productivity/first-response-time

  • Read

    Productivity - Replies Sent

    Productivity - Replies Sent

    GET /v2/reports/productivity/replies-sent

  • Read

    Productivity - Resolution Time

    Productivity - Resolution Time

    GET /v2/reports/productivity/resolution-time

  • Read

    Productivity - Resolved

    Productivity - Resolved

    GET /v2/reports/productivity/resolved

  • Read

    Productivity - Response Time

    Productivity - Response Time

    GET /v2/reports/productivity/response-time

  • Read

    User/Team Overall Report

    User/Team Overall Report

    GET /v2/reports/user

  • Read

    User Conversation History

    User Conversation History

    GET /v2/reports/user/conversation-history

  • Read

    User Customers Helped

    User Customers Helped

    GET /v2/reports/user/customers-helped

  • Read

    User Drill-down

    User Drill-down

    GET /v2/reports/user/drilldown

  • Read

    User Happiness

    User Happiness

    GET /v2/reports/user/happiness

  • Read

    User Happiness drilldown

    User Happiness drilldown

    GET /v2/reports/user/ratings

  • Read

    User Replies

    User Replies

    GET /v2/reports/user/replies

  • Read

    User Resolutions

    User Resolutions

    GET /v2/reports/user/resolutions

  • Read

    User/Team Chat Report

    User/Team Chat Report

    GET /v2/reports/user/chat

  • Read

    Chat Report

    Chat Report

    GET /v2/reports/chat

  • Read

    Email Report

    Email Report

    GET /v2/reports/email

  • Read

    Phone Report

    Phone Report

    GET /v2/reports/phone

System-Users

  • Read

    Get System User

    Get System User

    GET /v3/system-users/{systemUserId}

  • Read

    List System Users

    List System Users

    GET /v3/system-users

Tags

  • Read

    Get Tag by ID

    Get Tag by ID

    GET /v2/tags/{tagId}

  • Read

    List Tags

    List Tags

    GET /v2/tags

Teams

  • Read

    List Team Members

    List Team Members

    GET /v2/teams/{teamId}/members

  • Read

    List Teams

    List Teams

    GET /v2/teams

  • Destructive

    Update Team Members

    Update Team Members

    PUT /v2/teams/{teamId}/members

Users

  • Read

    List Users

    List Users

    GET /v2/users

  • Read

    Get Conversation Reassignment configuration

    Get Conversation Reassignment configuration

    GET /v2/users/{userId}/conversation-reassignment

  • Read

    Get user status

    Get user status

    GET /v2/users/{userId}/status

  • Read

    List users statuses

    List users statuses

    GET /v2/users/status

  • Read

    Get Resource Owner

    Get Resource Owner

    GET /v2/users/me

  • Read

    Get User

    Get User

    GET /v2/users/{userId}

  • Write

    Update Conversation Reassignment configuration

    Update Conversation Reassignment configuration

    PUT /v2/users/{userId}/conversation-reassignment

  • Write

    Set user status

    Set user status

    PUT /v2/users/{userId}/status

  • Write

    Create User

    Create User

    POST /v2/users

  • Destructive

    Delete User

    Delete User

    DELETE /v2/users/{userId}

Webhooks

  • Read

    Get Webhook

    Get Webhook

    GET /v2/webhooks/{webhookId}

  • Read

    List Webhooks

    List Webhooks

    GET /v2/webhooks

  • Write

    Create Webhook

    Create Webhook

    POST /v2/webhooks

  • Destructive

    Delete Webhook

    Delete Webhook

    DELETE /v2/webhooks/{webhookId}

  • Destructive

    Update Webhook

    Update Webhook

    PUT /v2/webhooks/{webhookId}

Workflows

  • Read

    List Workflows

    List Workflows

    GET /v2/workflows

  • Write

    Run Manual Workflows

    Run Manual Workflows

    POST /v2/workflows/{workflowId}/run

  • Destructive

    Update workflow status

    Update workflow status

    PATCH /v2/workflows/{workflowId}

Get started

  1. Open Space settings → Connections and search for Help Scout.
  2. Connect your account and add the connection to the Space.
  3. Ask for what you need in any thread in that Space.

See How connections work for access and permissions, or browse all integrations.