TakeForm
  • Welcome to TakeForm
  • TakeForm Pricing
  • Credits Refund Policy (Our Commitment)
  • Web Platform
    • Fill PDF form
    • Request New PDF Form
  • Developer API
    • API Key
    • API Webhook
    • TakeForm OpenAPI Document
    • Example: Fill Form via API
    • Get Fill Form API Example in Web App
  • Security and Privacy
    • Data Security & Policy
    • Data Deletion Policy
    • Data Collection & Usage
    • Our Compliance
  • About TakeForm
    • Contact Us
    • TakeForm Community
    • Business & Partnership
Powered by GitBook
On this page
  1. Developer API

TakeForm OpenAPI Document

PreviousAPI WebhookNextExample: Fill Form via API

Last updated 5 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
filled_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
get
curl -L \
  --url 'https://api.takeform.app/developer/v1/filled-forms/{filled_form_id}/download-url' \
  --header 'X-API-Key: YOUR_API_KEY'
200
400
401
404
500
text
get
Authorizations
Path parameters
filled_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
get
curl -L \
  --url 'https://api.takeform.app/developer/v1/filled-forms/{filled_form_id}' \
  --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": null,
  "status": null,
  "updated_at": 1,
  "created_at": 1,
  "name": "text"
}
  • GET/forms
  • POST/forms/{form_id}/fill
  • GET/filled-forms/{filled_form_id}/download-url
  • GET/filled-forms/{filled_form_id}
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
get
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": "Received",
    "is_draft": true,
    "user_id": "123e4567-e89b-12d3-a456-426614174000",
    "cost": 1
  }
]
post
Authorizations
Path parameters
form_idstring · uuidrequired
Body

Payload structure containing the list of sources used for form filling.

sourcesany of[]required

List of sources, which may include plain text or files.

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
post
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
{
  "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": null,
  "status": null,
  "updated_at": 1,
  "created_at": 1,
  "name": "text"
}