superoffice

SuperOffice

SuperOffice is a CRM platform that helps businesses manage their sales, marketing, and customer service activities. It's primarily used by sales, marketing, and customer support teams in mid-sized to large companies to improve customer relationships and streamline their processes. SuperOffice also offers ticketing and customer success features.

Official docs: https://developer.superoffice.com/

SuperOffice Overview

• Contact
• Sale
• Person
• Project
• Selection
• Document
• Appointment
• Follow Up
• Request
• Ticket
• Email
• Chat
• Task
• Time Registration
• Diary
• Quote
• Order
• Subscription
• Product
• Knowledge Base Article
• Activity
• Associate
• Document Template
• Dashboard
• Report
• Screen
• List
• Card
• Guide
• Search
• Notification
• Setting
• User
• Group
• Role
• License
• Database
• Server
• Integration
• Application
• Customization
• Workflow
• Macro
• Script
• Language
• Translation
• Currency
• Country
• State
• City
• Address
• Phone Number
• Email Address
• Web Site
• Social Media
• Note
• Attachment
• Category
• Status
• Priority
• Reason
• Source
• Campaign
• Goal
• Event
• Competitor
• Supplier
• Partner
• Customer
• Employee
• Manager
• Team
• Department
• Office
• Building
• Room
• Equipment
• Service
• Contract
• Invoice
• Payment
• Shipment
• Delivery
• Return
• Warranty
• Support
• Training
• Consulting
• Maintenance
• Upgrade
• Backup
• Restore
• Archive
• Delete
• Merge
• Import
• Export
• Print
• Send
• Receive
• Create
• Read
• Update
• Delete
• List
• Search
• Get
• Find
• Add
• Remove
• Assign
• Unassign
• Connect
• Disconnect
• Start
• Stop
• Pause
• Resume
• Complete
• Approve
• Reject
• Forward
• Reply
• Reply All
• Schedule
• Reschedule
• Cancel
• Confirm
• Decline
• Delegate
• Escalate
• Notify
• Remind
• Follow Up
• Log
• Track
• Monitor
• Analyze
• Forecast
• Calculate
• Convert
• Validate
• Verify
• Authenticate
• Authorize
• Encrypt
• Decrypt
• Sign
• Verify Signature
• Backup
• Restore
• Archive
• Delete
• Merge
• Import
• Export
• Print
• Send
• Receive

Use action names and parameters as needed.

Working with SuperOffice

This skill uses the Membrane CLI to interact with SuperOffice. Membrane handles authentication and credentials refresh automatically — so you can focus on the integration logic rather than auth plumbing.

Install the CLI

Install the Membrane CLI so you can run membrane from the terminal:

npm install -g @membranehq/cli@latest

Authentication

membrane login --tenant --clientName=<agentType>

This will either open a browser for authentication or print an authorization URL to the console, depending on whether interactive mode is available.

Headless environments: The command will print an authorization URL. Ask the user to open it in a browser. When they see a code after completing login, finish with:

membrane login complete <code>

Add --json to any command for machine-readable JSON output.

Agent Types : claude, openclaw, codex, warp, windsurf, etc. Those will be used to adjust tooling to be used best with your harness

Connecting to SuperOffice

Use membrane connection ensure to find or create a connection by app URL or domain:

membrane connection ensure "https://www.superoffice.com/" --json

The user completes authentication in the browser. The output contains the new connection id.

This is the fastest way to get a connection. The URL is normalized to a domain and matched against known apps. If no app is found, one is created and a connector is built automatically.

If the returned connection has state: "READY", skip to Step 2.

1b. Wait for the connection to be ready

If the connection is in BUILDING state, poll until it's ready:

npx @membranehq/cli connection get <id> --wait --json

The --wait flag long-polls (up to --timeout seconds, default 30) until the state changes. Keep polling until state is no longer BUILDING.

The resulting state tells you what to do next:

• READY — connection is fully set up. Skip to Step 2.
• CLIENT_ACTION_REQUIRED — the user or agent needs to do something. The clientAction object describes the required action:
• clientAction.type — the kind of action needed:
• "connect" — user needs to authenticate (OAuth, API key, etc.). This covers initial authentication and re-authentication for disconnected connections.
• "provide-input" — more information is needed (e.g. which app to connect to).
• clientAction.description — human-readable explanation of what's needed.
• clientAction.uiUrl (optional) — URL to a pre-built UI where the user can complete the action. Show this to the user when present.
• clientAction.agentInstructions (optional) — instructions for the AI agent on how to proceed programmatically.

After the user completes the action (e.g. authenticates in the browser), poll again with membrane connection get <id> --json to check if the state moved to READY.

• CONFIGURATION_ERROR or SETUP_FAILED — something went wrong. Check the error field for details.

Searching for actions

Search using a natural language description of what you want to do:

membrane action list --connectionId=CONNECTION_ID --intent "QUERY" --limit 10 --json

You should always search for actions in the context of a specific connection.

Each result includes id, name, description, inputSchema (what parameters the action accepts), and outputSchema (what it returns).

Popular actions

| Name | Key | Description | |---|---|---| | List Contacts | list-contacts | List all contacts (companies/organizations) with optional filtering and pagination | | List Users | list-users | List all users with optional filtering and pagination | | List Documents | list-documents | List all documents with optional filtering and pagination | | List Projects | list-projects | List all projects with optional filtering and pagination | | List Tickets | list-tickets | List all support tickets with optional filtering and pagination | | List Appointments | list-appointments | List all appointments/activities with optional filtering and pagination | | List Sales | list-sales | List all sales with optional filtering and pagination | | List Persons | list-persons | List all persons (contacts/individuals) with optional filtering and pagination | | Get Contact | get-contact | Get a contact (company/organization) by ID | | Get User | get-user | Get a user by ID | | Get Document | get-document | Get a document by ID | | Get Project | get-project | Get a project by ID | | Get Ticket | get-ticket | Get a support ticket by ID | | Get Appointment | get-appointment | Get an appointment by ID | | Get Sale | get-sale | Get a sale by ID | | Get Person | get-person | Get a person by ID | | Create Contact | create-contact | Create a new contact (company/organization) | | Create Document | create-document | Create a new document entity | | Create Project | create-project | Create a new project | | Create Ticket | create-ticket | Create a new support ticket |

Running actions

membrane action run <actionId> --connectionId=CONNECTION_ID --json

To pass JSON parameters:

membrane action run <actionId> --connectionId=CONNECTION_ID --input '{"key": "value"}'