n8n-nodes-outseta/README.md

n8n community node for Outseta CRM integration - manage people, accounts, and deals

# n8n-nodes-outseta

![n8n](https://img.shields.io/badge/n8n-community%20node-ff6d5a.svg)
![npm](https://img.shields.io/npm/v/n8n-nodes-outseta.svg)
![license](https://img.shields.io/npm/l/n8n-nodes-outseta.svg)

An n8n community node for integrating with Outseta CRM. This node allows you to manage people, accounts, and deals in your Outseta CRM directly from your n8n workflows.

## Installation

Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation.

### Community Nodes (Recommended)

1. Go to **Settings > Community Nodes**.
2. Select **Install**.
3. Enter `n8n-nodes-outseta` as the npm package name.
4. Agree to the [risks](https://docs.n8n.io/integrations/community-nodes/risks/) of using community nodes.
5. Select **Install**.

### Manual Installation

To get started:

```bash
npm install n8n-nodes-outseta
```

## Credentials

You'll need to configure your Outseta API credentials:

1. **API Key**: Found in Settings > Integrations > API Keys in your Outseta dashboard
2. **Secret Key**: Shown only when creating the API Key (store it securely)
3. **Domain**: Your Outseta domain (e.g., `yourcompany.outseta.com`)

## Operations

### People Resource

- **Create**: Add a new person to your CRM
- **Delete**: Remove a person from your CRM
- **Get**: Retrieve a specific person by UID
- **Get Many**: Retrieve multiple people with pagination support
- **Update**: Update an existing person's information

### Accounts Resource

- **Create**: Add a new account to your CRM
- **Delete**: Remove an account from your CRM
- **Get**: Retrieve a specific account by UID
- **Get Many**: Retrieve multiple accounts with pagination support
- **Send Confirmation**: Send confirmation emails to account members
- **Update**: Update an existing account's information

### Deals Resource

- **Create**: Add a new deal to your CRM
- **Delete**: Remove a deal from your CRM
- **Get**: Retrieve a specific deal by UID
- **Get Many**: Retrieve multiple deals with pagination support
- **Update**: Update an existing deal's information

## Features

- ✅ **Full CRM Support**: Manage people, accounts, and deals
- ✅ **Advanced Filtering**: Filter by email, name, account stage, and more
- ✅ **Pagination**: Efficient handling of large datasets with offset/limit
- ✅ **Field Selection**: Choose specific fields to return with partial responses
- ✅ **Account Stages**: Support for Demo, Trialing, Subscribing, etc.
- ✅ **Error Handling**: Comprehensive error messages and validation
- ✅ **JSON-Based**: Uses n8n's modern JSON-based node implementation

## Example Usage

### Create a New Person

```json
{
  "resource": "people",
  "operation": "create",
  "email": "john.doe@example.com",
  "firstName": "John",
  "lastName": "Doe",
  "additionalFields": {
    "phoneMobile": "+1-555-123-4567"
  }
}
```

### Get Person by Email

```json
{
  "resource": "people",
  "operation": "getAll",
  "additionalOptions": {
    "filterByEmail": "john.doe@example.com",
    "fields": "Uid,Email,FirstName,LastName"
  }
}
```

### Get Accounts by Person Email

```json
{
  "resource": "accounts",
  "operation": "getAll", 
  "additionalOptions": {
    "filterByPersonEmail": "john.doe@example.com",
    "fields": "Uid,Name,AccountStage,PersonAccount"
  }
}
```

### Get All Accounts with Stage Filtering

```json
{
  "resource": "accounts", 
  "operation": "getAll",
  "additionalOptions": {
    "filterByAccountStage": 2,
    "limit": 25,
    "offset": 0,
    "fields": "Uid,Name,AccountStage"
  }
}
```

### Create a Deal

```json
{
  "resource": "deals",
  "operation": "create",
  "dealName": "Enterprise Contract",
  "additionalFields": {
    "amount": 50000,
    "accountUid": "abc123"
  }
}
```

## API Documentation

For detailed information about the Outseta API, refer to the [official API documentation](https://documenter.getpostman.com/view/3613332/outseta-rest-api-v1/7TNfr6k).

## Rate Limiting

The Outseta API has a rate limit of 4 requests per second for API key authentication. This node respects these limits automatically.

## Support

- **Node Issues**: [GitHub Issues](https://github.com/alixmixx/n8n-nodes-outseta/issues)
- **Outseta API**: [support@outseta.com](mailto:support@outseta.com)
- **n8n Community**: [n8n Community Forum](https://community.n8n.io/)

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

## License

[MIT](LICENSE.md)