API Reference

curl -X GET "https://tyform.com/api/v1/forms" \
  -H "Authorization: Bearer YOUR_API_KEY"

https://api.tyform.com/v1

X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 1705312800

GET /forms

{
  "forms": [
    {
      "id": "abc123",
      "title": "Customer Survey",
      "status": "published",
      "responses_count": 150,
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-15T00:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 20,
    "total": 45
  }
}

GET /forms/{form_id}

{
  "id": "abc123",
  "title": "Customer Survey",
  "status": "published",
  "questions": [
    {
      "id": "q1",
      "type": "short_text",
      "title": "What's your name?",
      "required": true
    },
    {
      "id": "q2",
      "type": "email",
      "title": "What's your email?",
      "required": true
    }
  ],
  "settings": {
    "close_date": null,
    "response_limit": null
  },
  "theme": {
    "primary_color": "#6366f1"
  }
}

POST /forms

{
  "title": "New Survey",
  "questions": [
    {
      "type": "short_text",
      "title": "What's your name?",
      "required": true
    }
  ]
}

PATCH /forms/{form_id}

{
  "title": "Updated Title",
  "status": "closed"
}

DELETE /forms/{form_id}

GET /forms/{form_id}/responses

{
  "responses": [
    {
      "id": "resp_xyz",
      "submitted_at": "2024-01-15T10:30:00Z",
      "answers": {
        "q1": "John Doe",
        "q2": "john@example.com"
      }
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 20,
    "total": 150
  }
}

GET /forms/{form_id}/responses/{response_id}

DELETE /forms/{form_id}/responses/{response_id}

GET /forms/{form_id}/webhooks

POST /forms/{form_id}/webhooks

{
  "url": "https://your-server.com/webhook",
  "events": ["response.submitted"]
}

DELETE /forms/{form_id}/webhooks/{webhook_id}

{
  "error": {
    "code": "invalid_request",
    "message": "The request body is invalid",
    "details": {
      "field": "title",
      "issue": "Title is required"
    }
  }
}

GET /forms?page=2&per_page=50

{
  "data": [...],
  "pagination": {
    "page": 2,
    "per_page": 50,
    "total": 245,
    "total_pages": 5
  }
}

GET /forms/{form_id}/responses?since=2024-01-01&until=2024-01-31

GET /forms/{form_id}/responses?filter[q1]=John

npm install @tyform/sdk

import { Tyform } from '@tyform/sdk';

const tyform = new Tyform('YOUR_API_KEY');

// List forms
const forms = await tyform.forms.list();

// Get responses
const responses = await tyform.forms.responses('form_id', {
  since: new Date('2024-01-01'),
  perPage: 100
});

pip install tyform

from tyform import Tyform

client = Tyform('YOUR_API_KEY')

# List forms
forms = client.forms.list()

# Get responses
responses = client.forms.responses('form_id', since='2024-01-01')