TakeForm
  • Welcome to TakeForm
  • TakeForm Pricing
  • Credits Refund Policy (Our Commitment)
  • Web Platform
    • Fill a form
    • Request New Form
  • Developer
    • API Key
    • Developer API Docs
    • Integrations
  • About TakeForm
    • Contact Us
    • TakeForm Community
    • Business & Partnership
Powered by GitBook
On this page
  1. Developer

Developer API Docs

PreviousAPI KeyNextIntegrations

Last updated 4 days ago

You need an API Key to work with TakeForm Developer API. You can download TakeForm developer OpenAPI schema by . You can also interact with OpenAPI schema in

click here
https://api.takeform.app/developer
get
Authorizations
Path parameters
form_idstring · uuidrequired
Responses
application/json; charset=utf-8
application/json; charset=utf-8
application/json; charset=utf-8
application/json; charset=utf-8
application/json; charset=utf-8
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://api.takeform.app/developer/v1/filled-forms/{form_id}' \
  --header 'X-API-Key: YOUR_API_KEY'
200
400
401
404
500
{
  "filled_form": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "form_id": "123e4567-e89b-12d3-a456-426614174000",
    "file_id": "123e4567-e89b-12d3-a456-426614174000",
    "user_id": "123e4567-e89b-12d3-a456-426614174000",
    "filled_via": "Web",
    "status": "Created",
    "updated_at": 1,
    "created_at": 1,
    "name": "text"
  },
  "form_url": "text"
}
get
Authorizations
Responses
application/json; charset=utf-8
application/json; charset=utf-8
application/json; charset=utf-8
application/json; charset=utf-8
application/json; charset=utf-8
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://api.takeform.app/developer/v1/filled-forms' \
  --header 'X-API-Key: YOUR_API_KEY'
200
400
401
404
500
[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "form_id": "123e4567-e89b-12d3-a456-426614174000",
    "file_id": "123e4567-e89b-12d3-a456-426614174000",
    "user_id": "123e4567-e89b-12d3-a456-426614174000",
    "filled_via": "Web",
    "status": "Created",
    "updated_at": 1,
    "created_at": 1,
    "name": "text"
  }
]
  • POST/forms/{form_id}/fill
  • GET/forms
  • GET/filled-forms/{form_id}
  • GET/filled-forms
get
Authorizations
Responses
application/json; charset=utf-8
application/json; charset=utf-8
application/json; charset=utf-8
application/json; charset=utf-8
application/json; charset=utf-8
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://api.takeform.app/developer/v1/forms' \
  --header 'X-API-Key: YOUR_API_KEY'
200
400
401
404
500
[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "file_id": "123e4567-e89b-12d3-a456-426614174000",
    "index": 1,
    "updated_at": 1,
    "created_at": 1,
    "status": "None",
    "is_draft": true,
    "user_id": "123e4567-e89b-12d3-a456-426614174000",
    "cost": 1
  }
]
post
Authorizations
Path parameters
form_idstring · uuidrequired
Body
sourcesany of[]required
Responses
application/json; charset=utf-8
application/json; charset=utf-8
application/json; charset=utf-8
application/json; charset=utf-8
application/json; charset=utf-8
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url 'https://api.takeform.app/developer/v1/forms/{form_id}/fill' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json; charset=utf-8' \
  --data '{
    "sources": [
      {
        "type": "Text",
        "text": "text"
      }
    ]
  }'
200
400
401
404
500
{
  "filled_form": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "form_id": "123e4567-e89b-12d3-a456-426614174000",
    "file_id": "123e4567-e89b-12d3-a456-426614174000",
    "user_id": "123e4567-e89b-12d3-a456-426614174000",
    "filled_via": "Web",
    "status": "Created",
    "updated_at": 1,
    "created_at": 1,
    "name": "text"
  },
  "form_url": "text"
}