Submitted Forms

Lead capture forms

Retrieves submitted forms

get/submitted_forms

Returns a paginated list of submitted lead capture forms.

Forms can come from multiple sources: web forms, Meta (Facebook) lead ads, TikTok lead ads, or Typeform. Each form includes the raw responses and the associated contact.

Parámetros de consulta

  • pageinteger
    Page number for pagination
    Por defecto: 1Ejemplo: 1
  • limitinteger
    Number of records per page
    Por defecto: 25Ejemplo: 25
  • order_bystring
    Field to order results by
    Por defecto: created_atEjemplo: created_at
  • sortstring
    Sort direction (asc or desc)
    Valores:ascdescPor defecto: desc
  • sourcestring
    Filter by form source
    Valores:webmetatypeformtiktok
  • form_idstring
    Filter by form ID
    Ejemplo: form-123
  • contact_idstring
    Filter by contact ID
    Ejemplo: 507f1f77bcf86cd799439011
  • created_at_fromstring (date-time)
    Filter forms created from this date
    Ejemplo: 2024-01-01T00:00:00Z
  • created_at_tostring (date-time)
    Filter forms created until this date
    Ejemplo: 2024-12-31T23:59:59Z
  • updated_at_fromstring (date-time)
    Filter forms updated from this date
    Ejemplo: 2024-01-01T00:00:00Z
  • updated_at_tostring (date-time)
    Filter forms updated until this date
    Ejemplo: 2024-12-31T23:59:59Z

Respuestas

  • 200submitted forms found
  • 401unauthorized
Petición
curl -X GET 'https://api.vixiees.com/api/v1/submitted_forms' \
  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo · 200
{
  "results": [
    {
      "_id": "string",
      "form_id": "string",
      "form_name": "string",
      "source": "string",
      "field_errors": [
        null
      ],
      "typeform_response": {},
      "meta_response": {},
      "tiktok_response": {},
      "meta_webhook_change": {},
      "web_response": {},
      "meta_leadgen_id": "string",
      "meta_page_id": "string",
      "meta_page_name": "string",
      "meta_ad_id": "string",
      "meta_ad_name": "string",
      "meta_adgroup_id": "string",
      "meta_adgroup_name": "string",
      "contact_id": "string",
      "responses": [
        {
          "_id": "string",
          "input_id": "string",
          "label": "string",
          "field_string_value": "string",
          "field_date_value": "2024-01-01T00:00:00Z"
        }
      ],
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ],
  "page_info": {
    "current_page": "string",
    "limit": "string"
  }
}

Retrieves a submitted form

get/submitted_forms/{id}

Returns a single submitted form with all responses and metadata.

Parámetros de ruta

  • idstringobligatorio
    Submitted form ID

Respuestas

  • 200submitted form found
  • 401unauthorized
  • 404submitted form not found
Petición
curl -X GET 'https://api.vixiees.com/api/v1/submitted_forms/{id}' \
  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo · 200
{
  "id": "string",
  "form_id": "string",
  "form_name": "string",
  "source": "string",
  "field_errors": [
    null
  ],
  "typeform_response": {},
  "meta_response": {},
  "tiktok_response": {},
  "meta_webhook_change": {},
  "web_response": {},
  "meta_leadgen_id": "string",
  "meta_page_id": "string",
  "meta_page_name": "string",
  "meta_ad_id": "string",
  "meta_ad_name": "string",
  "meta_adgroup_id": "string",
  "meta_adgroup_name": "string",
  "contact_id": "string",
  "responses": [
    {
      "_id": "string",
      "input_id": "string",
      "label": "string",
      "field_string_value": "string",
      "field_date_value": "2024-01-01T00:00:00Z"
    }
  ],
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z"
}