Teamwork Crm

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  --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:

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

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 | Retrieve a list of contacts from Teamwork CRM. | | List Companies | list-companies | Retrieve a list of companies from Teamwork CRM. | | List Deals | list-deals | Retrieve a list of deals/opportunities from Teamwork CRM. | | List Activities | list-activities | Retrieve a list of activities from Teamwork CRM. | | List Users | list-users | Retrieve a list of users from Teamwork CRM. | | List Pipelines | list-pipelines | Retrieve a list of sales pipelines from Teamwork CRM. | | List Products | list-products | Retrieve a list of products from Teamwork CRM. | | List Notes | list-notes | Retrieve a list of notes from Teamwork CRM. | | Get Contact | get-contact | Retrieve a specific contact by ID from Teamwork CRM. | | Get Company | get-company | Retrieve a specific company by ID from Teamwork CRM. | | Get Deal | get-deal | Retrieve a specific deal by ID from Teamwork CRM. | | Get Activity | get-activity | Retrieve a specific activity by ID from Teamwork CRM. | | Create Contact | create-contact | Create a new contact in Teamwork CRM. | | Create Company | create-company | Create a new company in Teamwork CRM. | | Create Deal | create-deal | Create a new deal/opportunity in Teamwork CRM. | | Create Activity | create-activity | Create a new activity in Teamwork CRM. | | Create Note | create-note | Create a new note in Teamwork CRM, associated with a contact, company, or deal. | | Update Contact | update-contact | Update an existing contact in Teamwork CRM. | | Update Company | update-company | Update an existing company in Teamwork CRM. | | Update Deal | update-deal | Update an existing deal in Teamwork CRM. |

Running actions

membrane action run  --connectionId=CONNECTION_ID --json

To pass JSON parameters:

membrane action run  --connectionId=CONNECTION_ID --input '{"key": "value"}' --json

The result is in the output field of the response.

Proxy requests

When the available actions don't cover your use case, you can send requests directly to the Teamwork CRM API through Membrane's proxy. Membrane automatically appends the base URL to the path you provide and injects the correct authentication headers — including transparent credential refresh if they expire.

membrane request CONNECTION_ID /path/to/endpoint

Common options:

| Flag | Description | |------|-------------| | -X, --method | HTTP method (GET, POST, PUT, PATCH, DELETE). Defaults to GET | | -H, --header | Add a request header (repeatable), e.g. -H "Accept: application/json" | | -d, --data | Request body (string) | | --json | Shorthand to send a JSON body and set Content-Type: application/json | | --rawData | Send the body as-is without any processing | | --query | Query-string parameter (repeatable), e.g. --query "limit=10" | | --pathParam | Path parameter (repeatable), e.g. --pathParam "id=123" |

Best practices