Connecting to AgileCRM

Using Basic Authentication

AgileCRM uses Basic authentication with your login email address and API key. You can access the API key from your AgileCRM account by navigating to Admin Settings > Developers & API > API Key > REST API.

Set the following connection properties:

• AuthScheme: Set this to Basic.
• User: Set this to your AgileCRM login email address.
• Password: Set this to your AgileCRM REST API key.
• ProfileSettings: Set this to Domain=your_subdomain, where the domain is your AgileCRM subdomain. For example, if your AgileCRM account is acmeinc.agilecrm.com, set this to Domain=acmeinc.

Example Connection String

Profile=C:\profiles\AgileCRM.apip;AuthScheme=Basic;[email protected];Password=your_rest_api_key;ProfileSettings='Domain=acmeinc';

Available Tables

The AgileCRM API Profile provides access to the following tables:

• Campaigns: Returns a list of campaigns.
• ContactDeals: Fetches list of deals related to a specified contact using the contact ID.
• ContactNotes: Returns list of notes related to the contact.
• ContactTasks: Retrieves the tasks related to a contact, sorted by date (latest first).
• Contacts: Returns list of contacts in the domain ordered by creation time.
• DealBased: Fetches list of deals from a particular track. The track ID must be provided as a filter.
• DealNotes: Returns list of notes related to a deal.
• Deals: Returns a list of all Deals/Opportunities.
• Documents: Returns list of documents related to the contact.
• Events: Fetches the list of events that occurred in a particular time range.
• MyDeals: Returns deals belonging to the current user.
• Tasks: Returns list of tasks.
• TicketFilters: Returns list of ticket filters.
• TicketNotes: Returns the list of notes/messages for a specific ticket.
• Tickets: Returns list of tickets.
• Tracks: Gets all the tracks. Each track contains a set of milestones.

Usage Examples

Contacts:

SELECT * FROM Contacts

Deals:

SELECT * FROM Deals

ContactDeals:

SELECT * FROM ContactDeals WHERE ContactId = '1234567890'

ContactNotes:

SELECT * FROM ContactNotes WHERE ContactId = '1234567890'

ContactTasks:

SELECT * FROM ContactTasks WHERE ContactId = '1234567890'

Tasks:

SELECT * FROM Tasks

Tickets:

SELECT * FROM Tickets

TicketNotes:

SELECT * FROM TicketNotes WHERE TicketId = '1'

Tracks:

SELECT * FROM Tracks

DealBased:

SELECT * FROM DealBased WHERE TrackId = '1'

Events:

SELECT * FROM Events

Campaigns:

SELECT * FROM Campaigns

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.

---

Property	Description
AuthScheme	The scheme used for authentication. Accepted entries are Basic or None. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT, OAUTH_PASSWORD
Domain	The domain name in your AgileCRM account.
Password	The AgileCRM REST API key used as the password for Basic authentication.
User	The AgileCRM login email address used as the username for Basic authentication.