Query Contact List data from outside the CRM

The Forth CRM offers a contact list API. This will allow you to request a CSV file to be emailed to you directly or to a provided SFTP server.

This article includes the following topics:

• Before beginning
• Creating a basic post

Before beginning

To obtain contact list data from outside of Forth, you'll need the following:

• An Api-Key (Provided by support@setforth.com) - be sure you have an API Key. New API Keys can be obtained by emailing Support@setforth.com. In your email, clarify that you are requesting an API Key to use with the Contact List API. 
• A Contact list (with the List ID) - since you will be querying Forth for Contact List data, you'll need to obtain the ID number associated with the List that you are attempting to download:
   
  
  
• The API endpoint: https://api.forthcrm.com/v1/contacts/list
  
• *Optional - SFTP server

Creating a basic post

We will now demonstrate setting up a basic post. For this part, we will use Postman.

1. Open Postman (or other software) > create a new post > fill in the following information:
    
   
   

   IMPORTANT
   Make sure the Api-Key has a company name and user associated with it.

2. Click the Body tab > select Raw for the data type > select JSON for the coding language.
3. Paste either of the following JSON formatted code blocks depending on 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.

   
    
4. Input the List ID and other information by replacing the "XXX" in the code pasted above.
   
   
   
5. Click Send.
   The following message should appear if everything is done correctly.
   
   

Article Version History: