Getting Started with SalesRabbit+

✨ Overview

The SalesRabbit+ API is a RESTful API that allows developers to interact with the SalesRabbit+ platform programmatically. With our API, you can access a wide range of functionalities, including managing leads, users, areas, and more. It is designed to be simple, efficient, and scalable, making it an ideal choice for developers working on both small-scale and enterprise-level applications.

❗️The SalesRabbit+ API leverages the JSON API specification. Learn more here.

‼️ If you are using our EU server, please update the base URL from integrate.salesrabbit.com to integrate.ireland.salesrabbit.com

🔑 Key Features

• Comprehensive Data Access: Retrieve and manipulate data related to leads, users, areas, and more
• Real-time Updates: Keep your application in sync with real-time updates from SalesRabbit+
• Scalable and Secure: Handle large volumes of data with robust security measures in place
• Flexible Integration: Easily integrate with other systems and services using our RESTful endpoints

🚀 Getting Started

To start using the SalesRabbit+ API, follow these steps:

1. Obtain API Key

   First, you need to obtain your API key. This key will allow you to authenticate requests to the API. You can get your credentials by logging into your SalesRabbit+ account and navigating to Integrations --> API Keys. Here, you can create and name your API Key.
   Note: if you do not have access to the API Keys page, consult an account Owner or Admin to turn on the 'Integrations' permission for your role.

2. Authentication

   SalesRabbit+ API uses API keys to authenticate requests. Include your API key in the Authorization header of each request

3. Making Your First API Call

   Once you have your API credentials, you can start making API calls. Here’s a basic example using cURL to fetch a list of leads:

   curl -X GET "https://integrate.salesrabbit.com/v1/leads" -H "Authorization: Bearer YOUR_API_KEY"

4. Understanding the API Structure

   The SalesRabbit+ API is organized around RESTful principles. Resources are represented as URLs, and you use standard HTTP methods to interact with them:

   1. GET to retrieve a resource
   2. POST to create a new resource
   3. PUT or PATCH to update a resource
      1. PUT = Complete resource update (AKA you are expected to provide a complete representation of the resource and the server will replace the existing resource with the new data provided in the request)
      2. PATCH = Partial resource update (AKA you only send the changes you want to make, which increases efficiency if you're only updating some fields vs. all)
   4. DELETE to remove a resource

5. Passing Data to and From SalesRabbit**

   Sending Data to SalesRabbit To send data to SalesRabbit, you'll typically use the POST or PUT methods with a JSON payload. For example, to create a new lead, you would send a POST request like this:

   curl -X POST "https://integrate.salesrabbit.com/v1/leads" \
   -H "Authorization: Bearer YOUR_API_KEY" \
   -H "Content-Type: application/json" \
   -d '{
     "name": "John Doe",
     "email": "[email protected]",
     "phone": "+1234567890"
   }'

   Retrieving Data from SalesRabbit To retrieve data, use the GET method. For instance, to get details about a specific lead, you would make a request like this:

   curl -X GET "https://integrate.salesrabbit.com/v1/leads/{leadId}" \
   -H "Authorization: Bearer YOUR_API_KEY"

6. Handling API Responses

   The API returns responses in JSON format. Each response includes a status code indicating the success or failure of the request. A 200-level status code indicates success, while a 400-level or 500-level status code indicates an error.

7. Error Handling

   In case of an error, the response will include an error message with details about the issue. Make sure to handle these errors gracefully in your application to provide a smooth user experience.

💬 Need Help?

Our team is here to support you. If you get stuck, email us or drop a note in our Discussions page, and we'll get back to you ASAP.