Free CRM API for Developers

Free CRM API allows you to integrate data from your website, other web or cloud applications. Developers can use our REST API to add or get data from your account. You will need to get three things from the Administration Settings in your CRM Free account: your domain (url), Account ID and API Key. Using our api you can do the following:

• Add an Account or Contact
• Get / Search by Account or Contact Data
• Add an Address, Phone Number or Email to an Account or Contact
• Add a Sale or Opportunity to an Account
• Add a Support Ticket to an Account or Contact
• Get all Account: Types, Statuses and Sources
• Get all Users

The response from the api for each of the items above will return the corresponding ID and other data in json format. To use our api you will send data using the POST method and each section below will have an example using curl. Custom fields are not available through the api.

Add a Contact

To add a contact you can send the following data: First Name, Last Name, Address, Email, Phone, Title, Department and Comments. To have this contact assigned to an existing account, send the ID for the account as: account_ID. You get can the account_ID by using the SearchAccount event. Below is an example using curl to add a contact to your account:

curl -X POST -d \
'acc_id={your_acc_id}&api_key={your_api_key}&first=John&last=Doe&address=100 Main St&city=Chicago&state=IL&zip=60601&email=test@test.com&phone=2125551212&department=sales&title=Sales Manager&account_ID=373&comment=testing' \
{your_url}/api/?EventType=AddContact

The response from this example:
{
   "status": "200",
   "acc_id": "XXXXX",
   "contact_id": "12345"
}

Search a Contact

You can search for a contact using the following fields: contact_id, first, last, department, title. You can search by contact_id to retrive one contact's data or any combination of the other fields to find one or more matches. Below is an example using curl to search for a contact named John Doe in your account:

curl -X POST -d \
'acc_id={your_acc_id}&api_key={your_api_key}&first=John&last=Doe&department=&title=' \
{your_url}/api/?EventType=SearchContact

The response from this example:
{
   "status":"200",
   "acc_id":"XXXX",
   "Contacts":
     [
      {
        "contact_id":"12345",
        "first":"Charles",
        "last":"Cooper",
        "department":"Support",
        "title":"jr associate",
        "comments":"",
        "Addresses":
          [
            {
              "address":"321 Main St",
              "city":"Chicago",
              "state":"IL",
              "zip":"60601",
              "description":""
            }
          ],
        "Phones":
          [
            {
              "phone":"(312) 555-1212",
              "phone_type":"Cell",
              "phone_description":""
            },
            {
              "phone":"(847) 500-1212",
              "phone_type":"Work",
              "phone_description":""
            }
          ],
        "Emails":
          [
            {
              "email":"charles@test.com"
            }
          ]
      }
     ]
}

Add an Account

To add an account you can send the following data: Account Name, Address, Email, Phone, Source, Type, Status and Comments. The Source, Type and Status fields need to have the ID of an an existing option sent as the value. You can get the IDs using the following events: AccountSources, AccountTypes and AccountStatuses. Below is an example using curl to add a contact to your account:

curl -X POST -d \
'acc_id={your_acc_id}&api_key={your_api_key}&account_name=ABC Corp&address=100 Main St&city=Chicago&state=IL&zip=60601&email=test@test.com&phone=3125551212&source=5&type=133&status=3&comment=testing' \
{your_url}/api/?EventType=AddAccount

The response from this example:
{
   "status": "200",
   "acc_id": "XXXXX",
   "account_id": "54321"
}

Search an Account

You can search for a contact using the following fields: account_id, account_name source, type and status. You can search by account_id to retrive one account's data or any combination of the other fields to find one or more matches. Below is an example using curl to search for an account named ABC:

curl -X POST -d \
'acc_id={your_acc_id}&api_key={your_api_key}&account_name=ABC' \
{your_url}/api/?EventType=SearchAccount

The response from this example:
{
   "status":"200",
   "acc_id":"XXXX",
   "Accounts":
     [
      {
        "account_id":"54321",
        "name":"ABC Corp",
        "source":"5",
        "type":"133",
        "status":"3",
        "comments":"testing",
        "Addresses":
          [
            {
              "address":"123 Main St",
              "city":"Chicago",
              "state":"IL",
              "zip":"60601",
              "description":""
            }
          ],
        "Phones":
          [
            {
              "phone":"(312) 555-0000",
              "phone_type":"Work",
              "phone_description":""
            }
          ],
        "Emails":
          [
            {
              "email":"ABCcorp@test.com"
            }
          ]
      },
      {
        "account_id":"2453",
        "name":"Simple ABC LLC",
        "source":"13",
        "type":"64",
        "status":"25",
        "comments":"",
        "Phones":
          [
            {
              "phone":"(312) 000-1212",
              "phone_type":"Work",
              "phone_description":""
            }
          ],
        "Emails":
          [
            {
              "email":"SimpleABC@test.com"
            }
          ]
      }
     ]
}

Add an Address

To add an address to either an account or contact you can send the following data: contact_id, account_id, address, city, state and zip. You can send only one, either an account_id or a contact_id but not both, one is requried. Below is an example using curl to add a phone number to an account:

curl -X POST -d \
'acc_id={your_acc_id}&api_key={your_api_key}&account_id=54321&address=123 Main St&city=Chicago&state=IL&zip=60601' \
{your_url}/api/?EventType=AddAddress

The response from this example:
{
   "status": "200",
   "acc_id": "XXXXX",
   "account_id": "54321"
}

Add a Phone

To add a phone number to either an account or contact you can send the following data: contact_id, account_id, phone, phone_type and description. You can send only one, either an account_id or a contact_id but not both, one is requried. The phone_type field must contain a value of 1-5 (1: Cell, 2: Home, 3: Work, 4: fax, 5: Other). Below is an example using curl to add an address to an account:

curl -X POST -d \
'acc_id={your_acc_id}&api_key={your_api_key}&account_id=2453&phone=3120001212&phone_type=3&description=' \
{your_url}/api/?EventType=AddPhone

The response from this example:
{
   "status": "200",
   "acc_id": "XXXXX",
   "account_id": "2453"
}

Add an Email Address

To add an email address to either an account or contact you can send the following data: contact_id, account_id and email. You can send only one, either an account_id or a contact_id but not both, one is requried. Below is an example using curl to add an email address to an account:

curl -X POST -d \
'acc_id={your_acc_id}&api_key={your_api_key}&account_id=54321&email=ABCcorp@test.com' \
{your_url}/api/?EventType=AddEmail

The response from this example:
{
   "status": "200",
   "acc_id": "XXXXX",
   "account_id": "54321"
}

Get Account Types

To get a list of all account types and their ID numbers use the EventType AccountTypes. The ID number is what should be sent in the type field when adding an account. Below is an example using curl:

curl -X POST -d \
'acc_id={your_acc_id}&api_key={your_api_key}' \
{your_url}/api/?EventType=AccountTypes

The response from this example:
{
   "status": "200",
   "acc_id": "XXXXX",
   "Type":
     [
      {
        "id":"1"
        "name":"Industry A"
      },
      {
        "id":"2"
        "name":"Industry B"
      }
     ]
}

Get Account Statuses

To get a list of all account statuses and their ID numbers use the EventType AccountStatuses. The ID number is what should be sent in the status field when adding an account. Below is an example using curl:

curl -X POST -d \
'acc_id={your_acc_id}&api_key={your_api_key}' \
{your_url}/api/?EventType=AccountStatuses

The response from this example:
{
   "status": "200",
   "acc_id": "XXXXX",
   "Statuses":
     [
      {
        "id":"1"
        "name":"Prospect"
      },
      {
        "id":"2"
        "name":"Client"
      }
     ]
}

Get Account Sources

To get a list of all account sources and their ID numbers use the EventType AccountSources. The ID number is what should be sent in the source field when adding an account. Below is an example using curl:

curl -X POST -d \
'acc_id={your_acc_id}&api_key={your_api_key}' \
{your_url}/api/?EventType=AccountSources

The response from this example:
{
   "status": "200",
   "acc_id": "XXXXX",
   "Source":
     [
      {
        "id":"1"
        "name":"Online"
      },
      {
        "id":"2"
        "name":"Referral"
      }
     ]
}

Get Users

To get a list of all users and their ID numbers use the EventType GetUsers. Below is an example using curl:

curl -X POST -d \
'acc_id={your_acc_id}&api_key={your_api_key}' \
{your_url}/api/?EventType=GetUsers

The response from this example:
{
   "status": "200",
   "acc_id": "XXXXX",
   "Users":
     [
      {
        "id":"1"
        "name":"John Doe"
        "phone":"(312) 100-1212"
        "email":"john@test.com"
        "account_access":"No"
      },
      {
        "id":"2"
        "name":"Jane Doe"
        "phone":"(312) 101-1212"
        "email":"jane@test.com"
        "account_access":"Yes"
      }
     ]
}

Add a Sale / Opportunity

To add a sale to an account you can send the following data: Account ID, Title, Sales ID, Assigned To, Close Date, Status, Type, Value, Probability and Details. The account_ID is required to add a sale. The following fields: account_ID, assigned_to, status and type all must be sent as the ID number for each. You can get the IDs using the following EvetTpyes: SearchAccount, GetUsers, SaleStatuses and SaleTypes. The value for the Closed date (close_date) should be formatted as: YYYY-MM-DD. Below is an example using curl to add a sale:

curl -X POST -d \
'acc_id={your_acc_id}&api_key={your_api_key}&account_ID=54321&title=Widgets&sales_ID=63554&assigned_to=2&close_date=2020-11-15&status=2&type=5&value=2250&probability=60&details=Ordered 25 widgets' \
{your_url}/api/?EventType=AddSale

The response from this example:
{
   "status": "200",
   "acc_id": "XXXXX",
   "account_ID": "54321"
   "sale_id": "120"
}

Add a Support Ticket

To add a support ticket to an account or contact you can send the following data: Account ID, Contact ID, Title, Support ID, Assigned To, Level, Status, Type and Details. The account_ID or contact_ID is required to add a support ticket, but you cannot send both. The following fields: account_ID, contact_ID, assigned_to, level, status and type all must be sent as the ID number for each. You can get the IDs using the following EvetTpyes: SearchAccount, SearchContact, GetUsers, SupportLevels, SupportStatuses and SupportTypes. Below is an example using curl to add a support ticket:

curl -X POST -d \
'acc_id={your_acc_id}&api_key={your_api_key}&contact_ID=12345&title=Email Request&ticket_ID=1242&assigned_to=2&level=1&status=2&type=4&details=Client needs online assistance' \
{your_url}/api/?EventType=AddSupport

The response from this example:
{
   "status": "200",
   "acc_id": "XXXXX",
   "account_ID": "54321"
   "support_id": "217"
}

Get Sale Statuses

To get a list of all sale statuses and their ID numbers use the EventType SaleStatuses. The ID number is what should be sent in the status field when adding a sale. Below is an example using curl:

curl -X POST -d \
'acc_id={your_acc_id}&api_key={your_api_key}' \
{your_url}/api/?EventType=SaleStatuses

The response from this example:
{
   "status": "200",
   "acc_id": "XXXXX",
   "Statuses":
     [
      {
        "id":"1"
        "name":"New"
      },
      {
        "id":"2"
        "name":"Quoted"
      },
      {
        "id":"3"
        "name":"Pending"
      },
      {
        "id":"4"
        "name":"Won"
      },
      {
        "id":"5"
        "name":"Lost"
      }
     ]
}

Get Sale Types

To get a list of all sale types and their ID numbers use the EventType SaleTypes. The ID number is what should be sent in the type field when adding a sale. Below is an example using curl:

curl -X POST -d \
'acc_id={your_acc_id}&api_key={your_api_key}' \
{your_url}/api/?EventType=SaleTypes

The response from this example:
{
   "status": "200",
   "acc_id": "XXXXX",
   "Type":
     [
      {
        "id":"1"
        "name":"Online"
      },
      {
        "id":"2"
        "name":"Phone"
      }
     ]
}

Get Support Statuses

To get a list of all support statuses and their ID numbers use the EventType SupportStatuses. The ID number is what should be sent in the status field when adding a support ticket. Below is an example using curl:

curl -X POST -d \
'acc_id={your_acc_id}&api_key={your_api_key}' \
{your_url}/api/?EventType=SupportStatuses

The response from this example:
{
   "status": "200",
   "acc_id": "XXXXX",
   "Statuses":
     [
      {
        "id":"1"
        "name":"New"
      },
      {
        "id":"2"
        "name":"Opened"
      },
      {
        "id":"3"
        "name":"Escalated"
      },
      {
        "id":"4"
        "name":"Closed"
      }
     ]
}

Get Support Types

To get a list of all support types and their ID numbers use the EventType SupportTypes. The ID number is what should be sent in the type field when adding a support ticket. Below is an example using curl:

curl -X POST -d \
'acc_id={your_acc_id}&api_key={your_api_key}' \
{your_url}/api/?EventType=SupportTypes

The response from this example:
{
   "status": "200",
   "acc_id": "XXXXX",
   "Type":
     [
      {
        "id":"1"
        "name":"Email"
      },
      {
        "id":"2"
        "name":"Phone"
      }
     ]
}

Get Support Levels

To get a list of all support levels and their ID numbers use the EventType SupportLevels. The ID number is what should be sent in the level field when adding a support ticket. Below is an example using curl:

curl -X POST -d \
'acc_id={your_acc_id}&api_key={your_api_key}' \
{your_url}/api/?EventType=SupportLevels

The response from this example:
{
   "status": "200",
   "acc_id": "XXXXX",
   "Type":
     [
      {
        "id":"1"
        "name":"Gold"
      },
      {
        "id":"2"
        "name":"Silver"
      }
     ]
}