Skip to main content

Agile CRM

Agile CRM is an all-in-one customer relationship management platform that combines sales automation, marketing tools, and customer service features in a single cloud-based solution designed for small and growing businesses.

Agile CRM icon

Power end-to-end data operations for your Agile CRM API with Nexla. Our bi-directional Agile CRM connector is purpose-built for Agile 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 Agile CRM or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Agile 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 an Agile CRM credential in Nexla, you need to obtain your user email, REST API key, and domain name from your Agile CRM account. These credentials authenticate Nexla with the Agile CRM API and should be kept secure.

To obtain your Agile CRM API credentials, follow these steps:

  1. Sign in to your Agile CRM account.

  2. Navigate to Settings in your Agile CRM account to access the settings page.

  3. Locate the API section in the settings menu. This section contains your API credentials and access tokens.

  4. Copy your User Email. This should be the email address of a user authorized to access the API. The email is used as the username for basic authentication.

  5. Copy your REST API Key. This is a secret key that authenticates API requests and provides access to your Agile CRM account data. The API key is used as the password for basic authentication.

  6. Identify your Domain Name. This is the subdomain portion of your Agile CRM URL. For example, if your Agile CRM URL is yourcompany.agilecrm.com, your domain name is yourcompany. The domain name is used to construct the API endpoint URLs.

    Your user email, REST API key, and domain name are required for all Agile CRM API operations. Keep these credentials secure and do not share them publicly or commit them to version control systems. For detailed information about Agile CRM API authentication, see the Agile CRM REST API documentation.

Authenticate

Credentials required

FieldRequiredSecretDescription
User EmailYesNoEmail for user authorized to access the API
REST API KeyYesYesREST API key for your Agile CRM account.
Domain (eg: yourcompany in yourcompany.agilecrm.com)YesNoThe domain name of your Agile CRM account. Ex, if your Agile CRM URL is yourcompany.agilecrm.com, set this field to yourcompany.

Create a credential in Nexla

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

New Credential Overlay – Agile CRM

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

  2. Enter your Agile CRM user email in the User Email field. This should be the email address of a user authorized to access the API. The email is used as the username for basic authentication.

  3. Enter your Agile CRM REST API key in the REST API Key field. This key authenticates Nexla with the Agile CRM API and should match the API key obtained from your Agile CRM account settings. The API key is used as the password for basic authentication.

  4. Enter your Agile CRM domain name in the Domain (eg: yourcompany in yourcompany.agilecrm.com) field. This should be the subdomain portion of your Agile CRM URL. For example, if your Agile CRM URL is yourcompany.agilecrm.com, enter yourcompany. The domain name is used to construct API endpoint URLs in the format https://{domain_name}.agilecrm.com/dev/api/{endpoint}.

    The user email, REST API key, and domain name provide full access to your Agile CRM account data through the API. Keep these credentials secure and do not share them publicly or commit them to version control systems. Agile CRM uses basic authentication with the email and API key, which allows Nexla to make authenticated requests to your account.

  5. 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/destination 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 Agile CRM connector tile, then select the credential that will be used to connect to the Agile CRM instance, and click Next; or, create a new Agile 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 Agile 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.

Get All Contacts

This endpoint retrieves all contacts in your Agile CRM domain. Use this endpoint when you need to access contact information for analysis, reporting, or integration with other systems.

  • This endpoint uses cursor-based pagination, automatically fetching additional pages as needed. By default, the endpoint retrieves up to 200 contacts per page.
  • The endpoint will return all contacts in your domain, including contact details, custom fields, and associated information.

This endpoint supports pagination through cursor tokens. Nexla automatically handles pagination to retrieve all available contacts. For detailed information about retrieving contacts, see the Agile CRM REST API documentation.

Get All Deals

This endpoint retrieves all deals in your Agile CRM domain. Use this endpoint when you need to access deal information for sales analysis, pipeline reporting, or integration with other systems.

  • This endpoint uses cursor-based pagination, automatically fetching additional pages as needed. By default, the endpoint retrieves up to 200 deals per page.
  • The endpoint will return all deals in your domain, including deal details, stage information, values, and associated contacts.

This endpoint supports pagination through cursor tokens. Nexla automatically handles pagination to retrieve all available deals. For detailed information about retrieving deals, see the Agile CRM REST API documentation.

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

Agile CRM data sources can also be manually configured to ingest data from any valid Agile CRM 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.

Agile CRM API endpoints typically follow the pattern https://{domain_name}.agilecrm.com/dev/api/{endpoint}, where {domain_name} is your Agile CRM domain name. For a complete list of available Agile CRM API endpoints, see the Agile CRM REST API documentation.

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 Agile 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.

Use as a destination

Click the + icon on the Nexset that will be sent to the Agile CRM destination, and select the Send to Destination option from the menu. Select the Agile CRM connector from the list of available destination connectors, then select the credential that will be used to connect to the Agile CRM organization, and click Next; or, create a new Agile CRM credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Agile CRM endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

Create Contacts

This endpoint creates new contacts in your Agile CRM account. Use this endpoint when you need to add contacts to your CRM from your Nexset data.

  • The endpoint will send the Nexset data as JSON in the request body to create contacts. Ensure your Nexset contains all required fields for contact creation, including contact name, email, and other relevant contact information.
  • Each record in the Nexset will be sent as a separate API request to create a new contact in your Agile CRM account.

The request body must contain valid JSON with all required fields for contact creation. For detailed information about required fields and data formats, see the Agile CRM REST API documentation.

Create or Update Deals

This endpoint creates new deals or updates existing deals in your Agile CRM account. Use this endpoint when you need to add or update deals in your CRM from your Nexset data. If a dataset includes a valid deal ID, the respective deal will be updated with the data sent in the request.

  • The endpoint will send the Nexset data as JSON in the request body to create or update deals. Ensure your Nexset contains all required fields for deal creation, including deal name, value, stage, and other relevant deal information.
  • If a record includes a valid deal ID, the existing deal will be updated with the provided data. Otherwise, a new deal will be created.
  • Each record in the Nexset will be sent as a separate API request to create or update a deal in your Agile CRM account.

The request body must contain valid JSON with all required fields for deal creation or update. For detailed information about required fields and data formats, see the Agile CRM REST API documentation.

Manual configuration

Agile CRM destinations can also be manually configured to send data to any valid Agile CRM API endpoint. 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, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Agile CRM API endpoints typically expect JSON format for request bodies and follow the pattern https://{domain_name}.agilecrm.com/dev/api/{endpoint}, where {domain_name} is your Agile CRM domain name. For update/upsert operations, include the ID of the object to be updated at the end of the URL.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Agile CRM endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Agile CRM endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.