Retrieving Contact List Data from outside the FORTH CRM

This guide provides the technical framework for accessing your FORTH CRM contact records from external environments. It is organized into the following sections:

• Overview
• Pre-Query Requirements
• Safety and Security
• Setting Up the Query
• Create a Query

Overview

Whether you are building a custom dashboard, syncing data with a third-party marketing tool, or performing an automated audit, the FORTH CRM's contact list API serves as the bridge between your CRM data and your external applications.

By using our standardized GET requests, you can request a CSV file to be emailed to you directly or to a provided SFTP server, allowing you to extract contact details, including custom fields and tags, without needing to log in to the CRM dashboard.
 

Pre-Query Requirements

Before attempting to query data from outside the FORTH CRM, ensure you have the following credentials and configurations ready. These will require Super Admin or Developer-level permissions.

* IMPORTANT: Make sure that the API-Key has a Company Name and User associated with it.

Safety and Security

An API Key grants direct access to sensitive Client Information (PII). Never share your key in public repositories (like GitHub) or via unencrypted email.

Setting Up the Query

All requests to the FORTH CRM must include your API-Key in the request header. FORTH uses the GET method to "read" data from your contact lists.

Endpoint: https://api.forthcrm.com/v1/contacts

Method 1: The Quick Test (cURL)

Use this in your terminal or command line to verify your connection immediately.

curl -X GET "https://api.forthcrm.com/v1/contacts?limit=10" \
    -H "Authorization: Bearer YOUR_API_KEY_HERE" \
    -H "Content-Type: application/json"

Method 2: The Data Script (Python)

This is ideal if you are pulling data into a spreadsheet, a database, or another software tool. It includes basic error handling to let you know if your key is invalid.

import requests
# Configuration
API_URL = "https://api.forthcrm.com/v1/contacts"
API_KEY = "YOUR_API_KEY_HERE"
headers = {
   "Authorization": f"Bearer {API_KEY}",
   "Content-Type": "application/json"
}
# Parameters (Filtering for specific lists or status)
params = {
   "status": "active",
   "limit": 50
}
def fetch_contacts():
   response = requests.get(API_URL, headers=headers, params=params)
   
   if response.status_code == 200:
       data = response.json()
       print(f"Successfully retrieved {len(data['contacts'])} contacts.")
       return data['contacts']
   else:
       print(f"Error: {response.status_code} - {response.text}")
       return None
# Execute
contact_list = fetch_contacts()

Back to Top

Understanding the Response

When you query the FORTH CRM, it will return a JSON object. Here is a breakdown of what that data structure typically looks like:

• id: The unique system identifier for the contact.
• first_name / last_name: Primary identity fields.
• custom_fields: An array containing any unique data points you've created in the FORTH CRM (e.g., "Lead Source" or "Credit Score").
• created_at: A timestamp (ISO 8601) showing when the contact entered the system.

Create a Query

You must use your own third party software to create a basic query. See the example below using Postman.

1. Open Postman (or other software) > create a new post > and then fill in the following information:
   • Change the type to POST
   • Enter Endpoint Location where indicated.
   • Under the Headers tab/section:
     1. Select API-key as the Key
     2. Enter the API-key from the FORTH CRM as the Value.
   • Under the Body tab/section:
     1. Select RAW for the data type.
     2. Select JSON as the coding language.
     3. Paste either of the following JSON formatted code blocks (depending in your import process - direct email or SFTP server).
        

NOTE: We recommend you replace all quotes with new ones, as importing them may impact how the platform processes your query.

2. Provide the List ID and other information by replacing the "XXX" in the code pasted above.
   
    
3. Click Send. You would receive a confirmation message like the one shown in the image below if everything is done correctly.

Back to Top

Tip: Rate Limiting

FORTH CRM APIs have "Rate Limits" to prevent server overload. If you receive a 429 Too Many Requests error, it means you're pinging the server too fast. Try adding a small delay (0.5 seconds) between large batches of queries.

Assistance

If you have any questions, contact our support team at support@setforth.com.

Article Version History: