Reference

Run GraphQL Query

Execute custom GraphQL queries and mutations against the Plain API to retrieve complex data, perform advanced operations, or access features not available through standard actions.

Fetch Company

Retrieves complete company profile information including name, domain, contact details, and contract value by company ID. Use this when you need to access or verify comprehensive company data for business operations.

Update Company

Create or update company information in Plain using either a company ID or domain name, including details like company name, domain, contract value, and account owner assignments.

Add Customer To Group

Assign a customer to one or more customer groups to organize your contacts and enable targeted communication strategies. This helps you segment your audience for personalized outreach and better relationship management.

Create Customer Group

Creates a new customer group in Plain to organize and segment your customers by characteristics like pricing tier or support level. Use this to establish customer categories that help you manage support workflows and prioritize communication more effectively.

List Customer Groups

Retrieve all customer groups in your account with optional filtering and pagination to organize and manage customer segments. Use this to view your customer group structure and metadata at a glance.

Remove Customer From Group

Removes a customer from one or more customer groups in Plain, allowing you to revoke group memberships and adjust customer access levels. This helps you manage customer segmentation as their status or needs change.

Get Customer By Email

Retrieve a customer's profile information using their email address, allowing you to quickly access account details, contact preferences, and history without knowing their customer ID.

Upsert Customer

Creates a new customer record or updates an existing one to keep your customer information current and synchronized across your business systems.

Delete Customer

Removes a customer record from your system permanently using their customer ID. Use this when you need to eliminate outdated, duplicate, or unwanted customer entries to keep your customer database clean and accurate.

Get Customer By ID

Retrieve complete customer information and details by looking up their unique ID in your system. This lets you quickly access a customer's profile, contact information, and account history whenever you need it.

Get Customers

Retrieve a list of your customers with options to filter, sort, and paginate through the results to find specific customer information.

Fetch Issues

Retrieves all issue tracker links (from Jira, Linear, GitHub, etc.) connected to a customer's support threads, giving you a complete view of external issues tied to customer conversations.

Send Message

Sends a new message within an existing conversation thread to communicate with team members or clients. This helps you maintain organized communication by keeping related messages grouped together.

Create Thread

Start a new conversation thread with a customer to organize and track communications in one place. This helps you keep all related messages together for better context and follow-up.

List Threads

Retrieve a paginated list of threads, with optional filtering by status, to manage and organize your communication history.

Get Thread By ID

Retrieves detailed information about a specific conversation thread, including customer details, current status, priority level, labels, and who it's assigned to. Use this to access all relevant context about a customer interaction in one request.

List Threads (Deprecated)

Retrieves a list of all support conversations (threads) from Plain, including their ID, status, and priority information. Use this to get an overview of customer support activity and manage conversations across your support queue.

Update Thread

Rename or update a thread's title to keep your conversations organized and easier to find. This helps you maintain clear communication channels as your discussion topics evolve or when you need to reflect the current status or focus of a conversation.

Fetch Tier

Retrieves detailed information about a specific tier using its ID, allowing you to access tier metadata and settings whenever you need to reference or validate tier details.

List Tiers

Retrieve a paginated list of available tiers to see your pricing options and tier details. Use this when you need to browse or inventory all tiers in your system.

Delete User

Remove a user account from your system permanently by their ID. Use this when you need to deactivate team members, clients, or contacts who no longer need access.

Get User By ID

Retrieve detailed information about a team member in your workspace, including their name, email, status, and avatar. This is useful for accessing specific team member data to manage your workspace or integrate with other tools.