Introduction
Welcome to ConnectFlow Dev. This guide will help you integrate our services into your application with ease and efficiency.
Authentication
All API requests require authentication using an API key. Include your API key in the request headers:
x-api-key: YOUR_API_KEYKeep your API key secure and never share it publicly.
Base URL
All API endpoints are relative to the following base URL:
http://dev.connectflow.app/api/v1Business API
Business Connections
GETRetrieve all connections associated with a business account.
Endpoint
/business/connections
Headers
| Header | Value | Required | Description |
|---|---|---|---|
| x-api-key | string | Yes | Your API key for authentication |
Example Request
curl -X GET \
'http://dev.connectflow.app/api/v1/business/connections' \
-H 'x-api-key: YOUR_API_KEY'Response Format
{
"businessId": "string",
"connections": [
{
"connectionId": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"jobTitle": "string",
"phone": "string",
"company": "string",
"note": "string",
"dateConnected": "string (ISO 8601 date)",
"locationConnected": "string",
"createdAt": "string (ISO 8601 date)",
"updatedAt": "string (ISO 8601 date)",
"user": {
"userId": "string",
"email": "string",
"firstName": "string",
"lastName": "string"
}
}
]
}Status Codes
| Status Code | Description |
|---|---|
| 200 | Success - The request was successful |
| 401 | Unauthorized - Invalid or missing API key |
| 403 | Forbidden - Insufficient permissions |
| 500 | Internal Server Error - Something went wrong on the server |
Business Webhooks
New Connection
TRIGGERWhen a new connection is created in ConnectFlow, we will send the following data structure to your configured webhook URL.
Webhook Payload
[
{
"id": "string",
"properties": {
"email": "string",
"firstname": "string",
"lastname": "string",
"phone": "string",
"company": "string",
"note": "string",
"dateConnected": "string (ISO 8601 date)",
"locationConnected": "string"
},
"user": {
"id": "string",
"properties": {
"email": "string",
"firstname": "string",
"lastname": "string"
}
}
}
]Support
Need Help?
We're here to help you with any questions or issues you might have. Choose the most convenient way to reach us: