ClickCease

formeagle API Documentation

Welcome to the Form Eagle API documentation. This guide will help you integrate Form Eagle with your applications.

Authentication

All API requests require authentication using your API token. You can find your token in the Account Settings page.

Example Request Header 
Authorization: YOUR_API_TOKEN

Rate Limits

API requests are limited based on your subscription plan:

Plan Daily Form Limit
Free 10 forms
Standard 100 forms
Pro 1,000 forms
Enterprise 5,000 forms

API Endpoints

Get Forms

Retrieve a paginated list of your forms with advanced filtering and sorting options.

Request 
GET /api/forms
Authorization: YOUR_API_TOKEN

Query Parameters:
page          - Page number (default: 1)
per_page      - Items per page (default: 10, max: 100)
platform      - Filter by platform (optional)
start_date    - Filter by start date (YYYY-MM-DD)
end_date      - Filter by end date (YYYY-MM-DD)
is_active     - Filter by active status (true/false)
search        - Search in title, page name, or form name
sort_by       - Sort field (created_at, title, platform, entries_count)
sort_order    - Sort direction (asc/desc)
Response 
{
  "forms": [
    {
      "id": 1,
      "title": "Contact Form",
      "platform": "facebook",
      "created_at": "2024-11-03T12:00:00Z",
      "is_active": true,
      "page_name": "My Page",
      "form_name": "Contact Us",
      "entries_count": 25,
      "last_fetch": "2024-11-03T14:30:00Z",
      "last_entry_at": "2024-11-03T13:45:00Z",
      "platform_user": "John Doe"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 10,
    "total_items": 50,
    "total_pages": 5,
    "has_next": true,
    "has_prev": false
  },
  "filters": {
    "platform": "facebook",
    "start_date": "2024-11-01",
    "end_date": "2024-11-30",
    "is_active": "true",
    "search": null,
    "sort_by": "created_at",
    "sort_order": "DESC"
  }
}

Get Form Entries

Retrieve paginated entries for a specific form with filtering and sorting options.

Request 
GET /api/forms/{form_id}/entries
Authorization: YOUR_API_TOKEN

Query Parameters:
page          - Page number (default: 1)
per_page      - Items per page (default: 10, max: 100)
start_date    - Filter by start date (YYYY-MM-DD)
end_date      - Filter by end date (YYYY-MM-DD)
sort_by       - Sort field (created_at, id)
sort_order    - Sort direction (asc/desc)
Response 
{
  "form": {
    "id": 1,
    "title": "Contact Form",
    "platform": "facebook",
    "platform_user": "John Doe",
    "page_name": "My Page",
    "form_name": "Contact Us",
    "is_active": true
  },
  "entries": [
    {
      "id": 1,
      "data": {
        "field_data": [
          {
            "name": "Full Name",
            "values": ["John Doe"]
          },
          {
            "name": "Email",
            "values": ["john@example.com"]
          }
        ]
      },
      "created_at": "2024-11-03T12:00:00Z",
      "platform_entry_id": "123456789"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 10,
    "total_items": 25,
    "total_pages": 3,
    "has_next": true,
    "has_prev": false
  },
  "filters": {
    "start_date": "2024-11-01",
    "end_date": "2024-11-30",
    "sort_by": "created_at",
    "sort_order": "DESC"
  }
}