API Documentation

Documentation for AI Agents and Developers to integrate with the GFAVIP Onboarding Hub.

Authentication

All API requests must include the X-API-Key header.

curl -H "X-API-Key: YOUR_API_KEY" http://onboard.gfavip.com/api/v1/contacts

You can generate API keys in the Dashboard Settings (Team access required).

Base URL

http://onboard.gfavip.com/api/v1

Endpoints

GET

/contacts

List all contacts (leads).

Query Parameters

  • page (int, default: 1) - Page number
  • per_page (int, default: 20) - Items per page
  • email (string, optional) - Filter by exact email match

Response Example

{
  "contacts": [
    {
      "id": "uuid-string",
      "name": "John Doe",
      "first_name": "John",
      "last_name": "Doe",
      "company_name": "Acme Inc",
      "email": "john@example.com",
      "status": "Cold",
      "source": "API",
      "tags": "vip, 2024",
      "website": "https://example.com",
      "created_at": "2024-03-20T10:00:00"
    }
  ],
  "total": 100,
  "pages": 5,
  "current_page": 1
}
POST

/contacts

Create a new contact.

Body Parameters (JSON)

  • email (string, required) - Unique email address
  • first_name (string, optional)
  • last_name (string, optional)
  • company_name (string, optional)
  • status (string, default: 'Cold') - e.g., Cold, Warm, Qualified
  • source (string, default: 'API')
  • website (string, optional)
  • tags (string, optional) - Comma separated
  • notes (string, optional)
  • custom_fields (object, optional) - JSON object for extra data

Response Example

{
  "id": "new-uuid-string",
  "message": "Contact created successfully"
}
PATCH

/contacts/<id>

Update an existing contact.

Body Parameters (JSON)

Include only fields you want to update.

  • status
  • tags
  • notes
  • first_name
  • last_name
  • company_name
  • website
  • custom_fields
POST

/contacts/<id>/comments

Add a comment to a contact's timeline.

Body Parameters (JSON)

  • content (string, required) - The text content of the comment

Response Example

{
  "id": "comment-uuid",
  "message": "Comment added successfully",
  "created_at": "2024-03-20T10:05:00"
}
GET

/contacts/<id>/comments

Get comment history for a contact.

Response Example

{
  "comments": [
    {
      "id": "comment-uuid",
      "content": "Sent outreach email #1",
      "user_id": "user-uuid",
      "user_name": "Lead Gen Agent",
      "created_at": "2024-03-20T10:05:00"
    }
  ]
}