Skip to main content

Capsule CRM

Capsule CRM is a customer relationship management platform that helps businesses track contacts, sales opportunities, projects, and tasks in one place. The Capsule API (v2) exposes this data over REST, letting you extract parties, opportunities, pipelines, tasks, and related CRM records for reporting, analytics, and integration.

Capsule CRM icon

Power end-to-end data operations for your Capsule CRM API with Nexla. Our bi-directional Capsule CRM connector is purpose-built for Capsule CRM, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Capsule CRM or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Capsule CRM workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a Capsule CRM credential, you need a Personal Access Token from your Capsule account. The Capsule API v2 authenticates every request with a bearer token that is sent in the Authorization header. Personal Access Tokens are the recommended way to connect a one-off integration such as Nexla, because each token is scoped to specific permissions and can be revoked at any time.

To generate a Personal Access Token, follow these steps:

  1. Sign in to your Capsule CRM account using your account credentials.

  2. Click your name in the top-right corner, then select My Preferences.

  3. In the left-hand menu, click API Authentication Tokens.

  4. Under Personal Access Tokens, click the Generate new API token button.

  5. Assign the token the permissions required for your use case. For ingesting data into Nexla, Read access is sufficient.

  6. After the token is generated, use the copy icon to copy the token value, and store it securely. Treat the token as sensitive information, since it grants access to your Capsule data.

Generate a separate token for each purpose and restrict its scope to only what is required. Tokens you no longer need can be revoked from the same API Authentication Tokens page. For detailed information about authentication and available endpoints, see the Capsule API documentation.

Authenticate

Credentials required

FieldRequiredSecretDescription
API KeyYesYesAPI key.

Create a credential in Nexla

  1. After selecting the data source type, click the Add Credential tile to open the Add New Credential overlay.

  2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  3. Enter your Capsule CRM Personal Access Token in the API Key field. Nexla sends this token as a bearer token in the Authorization header when it connects to the Capsule API, so it must be kept confidential.

    If your Personal Access Token is compromised, revoke it from My Preferences > API Authentication Tokens in Capsule and generate a new one. For more information, see the Capsule API documentation.

  4. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Capsule CRM connector tile, then select the credential that will be used to connect to your Capsule account, and click Next; or, create a new Capsule CRM credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Capsule CRM endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

[Rest API] List Users

This endpoint template retrieves the list of users in your Capsule account. Use it to sync user records for reporting or to map record ownership across your CRM data.

  • This endpoint returns all users accessible to your token. Nexla automatically paginates through the results to fetch the full set of records.

[Rest API] List Employees

This endpoint template retrieves the people associated with a specific party (an organisation or person) in Capsule. Use it to extract the individuals linked to a given account.

  • Enter the Party ID of the party whose associated people you want to retrieve. This parameter is required.
  • Nexla automatically paginates through the results to fetch the full set of records.

[Rest API] List Parties

This endpoint template retrieves the list of parties (organisations and people) in your Capsule account. Use it to sync your core contact records for analysis, reporting, or integration.

  • This endpoint returns all parties accessible to your token. Nexla automatically paginates through the results to fetch the full set of records.

[Rest API] List Tasks

This endpoint template retrieves the list of tasks in your Capsule account. Use it to track outstanding and completed activities across your CRM.

  • This endpoint returns all tasks accessible to your token. Nexla automatically paginates through the results to fetch the full set of records.

[Rest API] List Projects

This endpoint template retrieves the list of projects (cases) in your Capsule account. Use it to sync ongoing work items and engagements tracked in your CRM.

  • This endpoint returns all projects accessible to your token. Nexla automatically paginates through the results to fetch the full set of records.

[Rest API] List Opportunities

This endpoint template retrieves the list of sales opportunities in your Capsule account. Use it to analyze your pipeline, deal values, and sales performance.

  • This endpoint returns all opportunities accessible to your token. Nexla automatically paginates through the results to fetch the full set of records.

[Rest API] List Pipelines

This endpoint template retrieves the list of sales pipelines defined in your Capsule account. Use it to map opportunities to their pipelines for reporting.

  • This endpoint returns all pipelines accessible to your token. Nexla automatically paginates through the results to fetch the full set of records.

[Rest API] List Milestones

This endpoint template retrieves the list of milestones in your Capsule account. Milestones represent the stages an opportunity moves through in a pipeline.

  • This endpoint returns all milestones accessible to your token. Nexla automatically paginates through the results to fetch the full set of records.

[Rest API] List Site

This endpoint template retrieves site information for your Capsule account. Use it to fetch account-level metadata.

  • This endpoint returns the site records accessible to your token. Nexla automatically paginates through the results to fetch the full set of records.

[Rest API] List Tags

This endpoint template retrieves the tags defined for a given entity type in your Capsule account. Use it to sync the tag taxonomy applied to your CRM records.

  • Enter the Entity type whose tags you want to list. This parameter is required and must be one of parties, opportunities, or kases.
  • Nexla automatically paginates through the results to fetch the full set of records.

[Rest API] List Custom Fields

This endpoint template retrieves the custom field definitions for a given entity type in your Capsule account. Use it to understand the custom data model applied to your CRM records.

  • Enter the Entity type whose custom field definitions you want to list. This parameter is required and must be one of parties, opportunities, or kases.
  • Nexla automatically paginates through the results to fetch the full set of records.

[Rest API] List Lost Reasons

This endpoint template retrieves the list of lost reasons defined in your Capsule account. Lost reasons capture why opportunities were marked as lost.

  • This endpoint returns all lost reasons accessible to your token. Nexla automatically paginates through the results to fetch the full set of records.

[Rest API] List Board

This endpoint template retrieves the boards defined in your Capsule account. Use it to sync the board configuration used to organize your records.

  • This endpoint returns all boards accessible to your token. Nexla automatically paginates through the results to fetch the full set of records.

[Rest API] List Categories

This endpoint template retrieves the list of categories in your Capsule account. Use it to sync the category taxonomy applied to your CRM records.

  • This endpoint returns all categories accessible to your token. Nexla automatically paginates through the results to fetch the full set of records.

[Rest API] List Activity Types

This endpoint template retrieves the list of activity types defined in your Capsule account. Activity types classify the interactions logged against your records.

  • This endpoint returns all activity types accessible to your token. Nexla automatically paginates through the results to fetch the full set of records.

[Rest API] List Stages

This endpoint template retrieves the list of stages defined in your Capsule account. Stages represent the steps records move through in your pipelines.

  • This endpoint returns all stages accessible to your token. Nexla automatically paginates through the results to fetch the full set of records.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Capsule CRM data sources can also be manually configured to ingest data from any valid Capsule API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Capsule CRM data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.