PDFfiller

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

{
  "token_type": "Bearer",
  "expires_in": 86400,
  "access_token": "OWJlZTQxNWNmNzA1MTJmMTFkOWE3NjNhZjRjMTZkMDUyZTUwMDh",
  "refresh_token": "ci+Bb+H9Kok948mXKsmGU8uxAvNODdKrexJjMeCOgP9nQ2EE8Py6/HP"
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Body Params

grant_type

string

required

Authentication grant type

client_id

string

required

client_secret

string

required

username

string

required

User email, required for grant type 'password'

password

string

required

Password of user account, required for grant type 'password'

Response

Success - Access token information

token_type	string Access token type. Only Bearer supported
expires_in	integer Access token lifetime in seconds
access_token	string Access token to send with every API request
refresh_token	string Token which refreshes access token

errors	array

errors	array

errors	array

errors	array

errors	array

errors	array

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Obtain Authentication Token by Grant Type Refresh Token

Obtains authentication token based on provided Client ID and Client Secret

posthttps://api.pdffiller.com/v2/oauth/token

curl --request POST \
  --url https://api.pdffiller.com/v2/oauth/token%20

var request = require("request");

var options = { method: 'POST',
  url: 'https://api.pdffiller.com/v2/oauth/token%20' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/oauth/token%20")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.pdffiller.com/v2/oauth/token%20");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/oauth/token%20"

response = requests.request("POST", url)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

{
  "token_type": "Bearer",
  "expires_in": 86400,
  "access_token": "OWJlZTQxNWNmNzA1MTJmMTFkOWE3NjNhZjRjMTZkMDUyZTUwMDh",
  "refresh_token": "ci+Bb+H9Kok948mXKsmGU8uxAvNODdKrexJjMeCOgP9nQ2EE8Py6/HP"
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Body Params

grant_type

string

required

Authentication grant type

client_id

string

required

client_secret

string

required

refresh_token

string

required

Refresh token from other OAuth response. Can use once only, required for grant type ‘refresh_token’

Response

Success - Access token information

token_type	string Access token type. Only Bearer supported
expires_in	integer Access token lifetime in seconds
access_token	string Access token to send with every API request
refresh_token	string Token which refreshes access token

errors	array

errors	array

errors	array

errors	array

errors	array

errors	array

Templates

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Retrieves a list of uploaded templates

Retrieves a list of uploaded documents.

gethttps://api.pdffiller.com/v2/templates

curl --request GET \
  --url https://api.pdffiller.com/v2/templates \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.pdffiller.com/v2/templates',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/templates")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.pdffiller.com/v2/templates");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/templates"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("GET", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

{
  "total": 1,
  "current_page": 1,
  "per_page": 15,
  "prev_page_url": "string",
  "next_page_url": "string",
  "items": [
    {
      "id": 12345678,
      "name": "File_name.extension",
      "type": "docx",
      "status": "FINISHED",
      "created": 1457222400,
      "updated": 1457222400,
      "fillable": false,
      "folder": {
        "folder_id": 12345678,
        "name": "My_folder"
      }
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Query Params

folder_id

integer

date_from

string

Filter by date from.

date_to

string

Filter by date to.

per_page

integer

Filter by quantity of templates on the page

page

integer

Filter by page

order

string

Sort Method

order_by

string

Filter for sort by selected property

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

Success - list of uploaded document templates

total	integer
current_page	integer
per_page	integer
prev_page_url	string
next_page_url	string
items	array

errors	array

errors	array

errors	array

errors	array

errors	array

errors	array

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Creates a new document template by uploading file via URL

Creates a new document template. The filename must contain integers, English letters or special
characters: ( ) _ . Also, the filename extension should be .ppt; .pptx; .doc; .docx; or .pdf. Url should be direct to the file. You can download document from multipart

posthttps://api.pdffiller.com/v2/templates

curl --request POST \
  --url https://api.pdffiller.com/v2/templates \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'POST',
  url: 'https://api.pdffiller.com/v2/templates',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/templates")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.pdffiller.com/v2/templates");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/templates"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("POST", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

{
  "id": 12345678,
  "name": "File_name.extension",
  "type": "docx",
  "status": "FINISHED",
  "created": 1457222400,
  "updated": 1457222400,
  "fillable": false,
  "folder": {
    "folder_id": 12345678,
    "name": "My_folder"
  }
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Query Params

with_tags

boolean

All document tags will be rendered as fillable fields.

Body Params

file

string

required

the filename extension

should be .ppt; .pptx; .doc; .docx; or .pdf. e.g.: https://www.irs.gov/pub/irs-pdf/fw9.pdf or multipart fw9.pdf

name

string

folder_id

integer

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

Success - information about new document template

id	integer
name	string
type	string Original document extension. Document(s) uploaded to pdffiller will be converted to .pdf
status	string
created	integer
updated	integer
fillable	boolean
folder	object
folder.folder_id	integer
folder.name	string

errors	array

errors	array

errors	array

errors	array

errors	array

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Creates a new document template by uploading file from multipart

Creates a new document template via multipart. The filename must contain integers, English letters or special characters:( ) _ . Also, the filename extension should be .ppt; .pptx; .doc; .docx; or .pdf

posthttps://api.pdffiller.com/v2/templates

curl --request POST \
  --url https://api.pdffiller.com/v2/templates%20 \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'POST',
  url: 'https://api.pdffiller.com/v2/templates%20',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/templates%20")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.pdffiller.com/v2/templates%20");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/templates%20"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("POST", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

{
  "id": 12345678,
  "name": "File_name.extension",
  "type": "docx",
  "status": "FINISHED",
  "created": 1457222400,
  "updated": 1457222400,
  "fillable": false,
  "folder": {
    "folder_id": 12345678,
    "name": "My_folder"
  }
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Query Params

with_tags

boolean

All document tags will be rendered as fillable fields.

Body Params

file

string

required

name

string

folder_id

integer

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

Success - information about new document template

id	integer
name	string
type	string Original document extension. Document(s) uploaded to pdffiller will be converted to .pdf
status	string
created	integer
updated	integer
fillable	boolean
folder	object
folder.folder_id	integer
folder.name	string

errors	array

errors	array

errors	array

errors	array

errors	array

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Previews Document Template

Previews a document template.

gethttps://api.pdffiller.com/v2/templates/template_id/previews

curl --request GET \
  --url https://api.pdffiller.com/v2/templates/template_id/previews \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.pdffiller.com/v2/templates/template_id/previews',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/templates/template_id/previews")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.pdffiller.com/v2/templates/template_id/previews");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/templates/template_id/previews"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("GET", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

{
  "items": [
    "page_integer",
    "image"
  ],
  "total": 0
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Path Params

template_id

integer

required

Id of a document template.

Query Params

pages

integer

Page integers of the document template. Max length = 10.

scale

integer

Scale of preview pages. Min value - 10, max value - 500.

max_width

integer

Max width of preview pages. Min value - 10, max value - 3000.

max_height

integer

Max height of preview pages. Min value - 10, max value - 3000.

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

Success. Images of document pages.

items	array
total	integer

errors	array

errors	array

errors	array

errors	array

errors	array

errors	array

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Copy Documents

Copy any document: name the new document and select a destination folder.

posthttps://api.pdffiller.com/v2/templates/template_id

curl --request POST \
  --url https://api.pdffiller.com/v2/templates/template_id%20 \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'POST',
  url: 'https://api.pdffiller.com/v2/templates/template_id%20',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/templates/template_id%20")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.pdffiller.com/v2/templates/template_id%20");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/templates/template_id%20"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("POST", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

{
  "id": 12345678,
  "name": "File_name.extension",
  "type": "docx",
  "status": "FINISHED",
  "created": 1457222400,
  "updated": 1457222400,
  "fillable": false,
  "folder": {
    "folder_id": 12345678,
    "name": "My_folder"
  }
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Path Params

template_id

integer

required

Id of a template.

Body Params

name

string

action

string

required

folder_id

integer

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

Success - filled the form template

id	integer
name	string
type	string Original document extension. Document(s) uploaded to pdffiller will be converted to .pdf
status	string
created	integer
updated	integer
fillable	boolean
folder	object
folder.folder_id	integer
folder.name	string

errors	array

errors	array

errors	array

errors	array

errors	array

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Share The Document Via Link

Share your document via URL

posthttps://api.pdffiller.com/v2/templates/template_id/share

curl --request POST \
  --url https://api.pdffiller.com/v2/templates/template_id/share \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'POST',
  url: 'https://api.pdffiller.com/v2/templates/template_id/share',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/templates/template_id/share")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.pdffiller.com/v2/templates/template_id/share");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/templates/template_id/share"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("POST", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

{
  "url": "https://pdf.ac/aaaaa"
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Path Params

template_id

integer

required

Id of a template.

Body Params

accessType

string

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

Success

url	string

errors	array

errors	array

errors	array

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Information about created template

Retrieves information about a created document template.

gethttps://api.pdffiller.com/v2/templates/template_id

curl --request GET \
  --url https://api.pdffiller.com/v2/templates/template_id \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.pdffiller.com/v2/templates/template_id',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/templates/template_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.pdffiller.com/v2/templates/template_id");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/templates/template_id"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("GET", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

{
  "id": 12345678,
  "name": "File_name.extension",
  "type": "docx",
  "status": "FINISHED",
  "created": 1457222400,
  "updated": 1457222400,
  "fillable": false,
  "folder": {
    "folder_id": 12345678,
    "name": "My_folder"
  }
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Path Params

template_id

integer

required

Id of a template.

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

Success - Information about created document template

id	integer
name	string
type	string Original document extension. Document(s) uploaded to pdffiller will be converted to .pdf
status	string
created	integer
updated	integer
fillable	boolean
folder	object
folder.folder_id	integer
folder.name	string

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Updates template information

Updates the information for a document template.

puthttps://api.pdffiller.com/v2/templates/template_id

curl --request PUT \
  --url https://api.pdffiller.com/v2/templates/template_id \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.pdffiller.com/v2/templates/template_id',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/templates/template_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.pdffiller.com/v2/templates/template_id");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/templates/template_id"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("PUT", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

{
  "id": 12345678,
  "name": "File_name.extension",
  "type": "docx",
  "status": "FINISHED",
  "created": 1457222400,
  "updated": 1457222400,
  "fillable": false,
  "folder": {
    "folder_id": 12345678,
    "name": "My_folder"
  }
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Path Params

template_id

integer

required

Id of a template.

Body Params

name

string

folder_id

integer

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

Success - Information about updated document template

id	integer
name	string
type	string Original document extension. Document(s) uploaded to pdffiller will be converted to .pdf
status	string
created	integer
updated	integer
fillable	boolean
folder	object
folder.folder_id	integer
folder.name	string

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Deletes document template item

Deletes a document template item.

deletehttps://api.pdffiller.com/v2/templates/template_id

curl --request DELETE \
  --url https://api.pdffiller.com/v2/templates/template_id \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.pdffiller.com/v2/templates/template_id',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/templates/template_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.pdffiller.com/v2/templates/template_id");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/templates/template_id"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("DELETE", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

{
  "total": 0,
  "message": "string"
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Path Params

template_id

integer

required

Id of a template.

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

Success

total	integer
message	string

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Fills a fillable form template

Populates a fillable form template which was created with the PDFfiller editor.

posthttps://api.pdffiller.com/v2/templates/template_id

curl --request POST \
  --url https://api.pdffiller.com/v2/templates/template_id \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'POST',
  url: 'https://api.pdffiller.com/v2/templates/template_id',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/templates/template_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.pdffiller.com/v2/templates/template_id");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/templates/template_id"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("POST", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

{
  "id": 12345678,
  "name": "File_name.extension",
  "type": "docx",
  "status": "FINISHED",
  "created": 1457222400,
  "updated": 1457222400,
  "fillable": false,
  "folder": {
    "folder_id": 12345678,
    "name": "My_folder"
  }
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Path Params

template_id

integer

required

Id of a template.

Body Params

fillable_fields

object

fillable_fields.Field_name_1

string

fillable_fields.Field_name_2

string

name

string

Name created for a newly filled document

action

string

folder_id

integer

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

Success - filled the form template

id	integer
name	string
type	string Original document extension. Document(s) uploaded to pdffiller will be converted to .pdf
status	string
created	integer
updated	integer
fillable	boolean
folder	object
folder.folder_id	integer
folder.name	string

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Downloads document template

Downloads a document template.

gethttps://api.pdffiller.com/v2/templates/template_id/download

curl --request GET \
  --url https://api.pdffiller.com/v2/templates/template_id/download \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.pdffiller.com/v2/templates/template_id/download',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/templates/template_id/download")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.pdffiller.com/v2/templates/template_id/download");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/templates/template_id/download"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("GET", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

undefined

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Path Params

template_id

integer

required

Id of a template.

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

OK

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

List Template Roles

Retrieves a list of roles for a document template.

gethttps://api.pdffiller.com/v2/templates/template_id/roles

curl --request GET \
  --url https://api.pdffiller.com/v2/templates/template_id/roles \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.pdffiller.com/v2/templates/template_id/roles',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/templates/template_id/roles")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.pdffiller.com/v2/templates/template_id/roles");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/templates/template_id/roles"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("GET", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

{
  "total": 1,
  "current_page": 1,
  "per_page": 15,
  "prev_page_url": "string",
  "next_page_url": "string",
  "items": [
    {
      "id": 777,
      "document_id": 11111111,
      "role_name": "Developer",
      "order": 0
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Path Params

template_id

integer

required

Id of a template.

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

Success. Roles list

total	integer
current_page	integer
per_page	integer
prev_page_url	string
next_page_url	string
items	array

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Original Document Download

Retrieves original document.

gethttps://api.pdffiller.com/v2/templates/template_id/original_document

curl --request GET \
  --url https://api.pdffiller.com/v2/templates/template_id/original_document \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.pdffiller.com/v2/templates/template_id/original_document',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/templates/template_id/original_document")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.pdffiller.com/v2/templates/template_id/original_document");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/templates/template_id/original_document"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("GET", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

undefined

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Path Params

template_id

integer

required

Id of a template.

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

OK

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Fillable fields for selected document template with values

Get values for a fillable form.

gethttps://api.pdffiller.com/v2/templates/template_id/fields

curl --request GET \
  --url https://api.pdffiller.com/v2/templates/template_id/fields \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.pdffiller.com/v2/templates/template_id/fields',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/templates/template_id/fields")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.pdffiller.com/v2/templates/template_id/fields");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/templates/template_id/fields"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("GET", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

[
  {
    "type": "text",
    "name": "YourCustomFieldName",
    "initial": "default value",
    "required": true,
    "label": "Text for user's",
    "fillable": true,
    "maxLines": 2,
    "maxChars": 200,
    "list": [
      "First Choice",
      "Second Choice"
    ],
    "allowCustomText": true,
    "radioGroup": "GroupName",
    "format": "yyyy-MM-dd",
    "value": "some_value"
  }
]

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Path Params

template_id

integer

required

Id of a template.

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

Success - fields list for selected document template

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Child documents for selected document template

Retrieves child documents for a selected document template.

gethttps://api.pdffiller.com/v2/templates/template_id/filled_documents

curl --request GET \
  --url https://api.pdffiller.com/v2/templates/template_id/filled_documents \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.pdffiller.com/v2/templates/template_id/filled_documents',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/templates/template_id/filled_documents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.pdffiller.com/v2/templates/template_id/filled_documents");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/templates/template_id/filled_documents"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("GET", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

{
  "total": 1,
  "current_page": 1,
  "per_page": 15,
  "prev_page_url": "string",
  "next_page_url": "string"
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Path Params

template_id

integer

required

Id of a template.

Query Params

per_page

integer

Filter by quantity of templates on the page

page

integer

Filter by page

order

string

Sort Method

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

Success - Information about child templates

total	integer
current_page	integer
per_page	integer
prev_page_url	string
next_page_url	string

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Downloads zip archive of signatures

Downloads a zip archive of document signatures.

gethttps://api.pdffiller.com/v2/templates/template_id/download_signatures

curl --request GET \
  --url https://api.pdffiller.com/v2/templates/template_id/download_signatures \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.pdffiller.com/v2/templates/template_id/download_signatures',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/templates/template_id/download_signatures")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.pdffiller.com/v2/templates/template_id/download_signatures");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/templates/template_id/download_signatures"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("GET", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

undefined

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Path Params

template_id

integer

required

Id of a template.

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

OK

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Create Template Constructor Link

Creates a new share link to a document.
Note: Callback notifications are unavailable for document authors saving edits via their Constructor link.

posthttps://api.pdffiller.com/v2/templates/template_id/constructor

curl --request POST \
  --url https://api.pdffiller.com/v2/templates/template_id/constructor \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'POST',
  url: 'https://api.pdffiller.com/v2/templates/template_id/constructor',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/templates/template_id/constructor")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.pdffiller.com/v2/templates/template_id/constructor");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/templates/template_id/constructor"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("POST", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

{
  "document_id": 1111111111,
  "hash": "string",
  "url": "some url",
  "short_url": "short link",
  "custom_logo_id": 4526,
  "redirect_url": "https://domain.com"
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Path Params

template_id

integer

required

Id of a template.

Body Params

expire

integer

Number of days left until link expires. Max value - 1000

callback_url

string

Callback destination url. Max value - 1000 characters

custom_logo_id

integer

Document custom logo id

redirect_url

string

Redirect uri. Max value - 1000 characters

editor_modules

object

editor_modules.tt

boolean

Follow the link for a full list of parameters https://docs.pdffiller.com/docs/embedded-js-client#section-editor-module-parameters-description

editor_modules.ta

boolean

Each parameter is optional. 'True' value makes no effect. Only 'false' changes the mode and turns off a module. Each module can have dependent "switched-off" mode.

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

Success - information about new share link

document_id	integer Template id which was shared
hash	string Hash for shared template
url	string Permalink to edit shared template
short_url	string Short link to edit shared template
custom_logo_id	integer Document custom logo id
redirect_url	string Redirect uri

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

List Hash

Retrieves a list of hash.

gethttps://api.pdffiller.com/v2/templates/template_id/constructor

curl --request GET \
  --url https://api.pdffiller.com/v2/templates/template_id/constructor \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.pdffiller.com/v2/templates/template_id/constructor',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/templates/template_id/constructor")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.pdffiller.com/v2/templates/template_id/constructor");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/templates/template_id/constructor"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("GET", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

{
  "items": [
    {
      "hash": "hash_string",
      "expiration": "2017-01-01 00:00:00",
      "url": "https://url.com/en/hash_string.htm",
      "custom_logo_id": 4526,
      "redirect_url": "https://domain.com"
    }
  ],
  "callback_urls": [
    "your_custom_or_global_callback_url, another_custom_or_global_callback_url"
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Path Params

template_id

integer

required

Id of a template.

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

Success

items	array
callback_urls	array

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Delete All Share Links

Deletes all share links to a document by id.

deletehttps://api.pdffiller.com/v2/templates/template_id/constructor

curl --request DELETE \
  --url https://api.pdffiller.com/v2/templates/template_id/constructor \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.pdffiller.com/v2/templates/template_id/constructor',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/templates/template_id/constructor")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.pdffiller.com/v2/templates/template_id/constructor");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/templates/template_id/constructor"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("DELETE", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

{
  "message": "All URLs to the documents were deleted"
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Path Params

template_id

integer

required

Id of a template.

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

Success - information about new share link

message	string

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Delete Share Link (hash)

Deletes one share link to a document by hash.

deletehttps://api.pdffiller.com/v2/templates/template_id/constructor/hash

curl --request DELETE \
  --url https://api.pdffiller.com/v2/templates/template_id/constructor/hash \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.pdffiller.com/v2/templates/template_id/constructor/hash',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/templates/template_id/constructor/hash")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.pdffiller.com/v2/templates/template_id/constructor/hash");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/templates/template_id/constructor/hash"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("DELETE", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

{
  "message": "One URL to the documents was deleted"
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Path Params

template_id

integer

required

Id of a template

hash

string

required

Hash for shared link

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

Success - information about new share link

message	string

Fillable Forms

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

List All Document Fill Requests

Returns a list of all document fill requests.

gethttps://api.pdffiller.com/v2/fillable_forms

curl --request GET \
  --url https://api.pdffiller.com/v2/fillable_forms \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.pdffiller.com/v2/fillable_forms',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/fillable_forms")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.pdffiller.com/v2/fillable_forms");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/fillable_forms"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("GET", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

{
  "total": 1,
  "current_page": 1,
  "per_page": 15,
  "prev_page_url": "string",
  "next_page_url": "string",
  "items": [
    {
      "fillable_form_id": 123456,
      "document_name": "Document.pdf",
      "access": "full",
      "status": "public",
      "email_required": true,
      "allow_downloads": false,
      "redirect_url": "https://www.pdffiller.com",
      "name_required": true,
      "custom_message": "Some custom message",
      "filled_forms_count": 0,
      "notification_emails": [
        {
          "name": "Username",
          "email": "some-email@domain.com"
        }
      ],
      "notifications": "disabled",
      "sender_notifications": false,
      "url": "https://pdf.ac/aaa4a",
      "enforce_required_fields": true,
      "custom_logo_id": 1234,
      "welcome_screen": false,
      "additional_documents": [
        {
          "name": "docs1",
          "files": [
            {
              "id": 119031,
              "filename": "filename.pdf",
              "ip": "109.237.93.134",
              "date_created": "2017-03-10 10:06:33"
            }
          ]
        }
      ],
      "reusable": true,
      "callbacks": [
        {
          "event_id": "fill_request.done",
          "callback_url": "http://url.com",
          "document_id": 123456789
        }
      ],
      "signature_stamp": false,
      "field_wizard": "on",
      "user_tokens": [
        {
          "org_id": 11,
          "user_id": 111,
          "token": "Wye9HXrbeuJXQJCVAr3i0gr3M9SXAOy",
          "url": "https://pdf.ac/11AAA1?token=Wye9HXrbeuJXQJCVAr3i0gr3M9SXAOy"
        }
      ]
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Query Params

per_page

integer

Filter by quantity of fillable forms on the page

page

integer

Filter by page

order

string

Sort Method

order_by

string

Filter for sort by custom property

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

Success - List of all created FillRequests

total	integer
current_page	integer
per_page	integer
prev_page_url	string
next_page_url	string
items	array

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Create a standard LinkToFill Document

Creates a new document and shares it via short url.

posthttps://api.pdffiller.com/v2/fillable_forms

curl --request POST \
  --url https://api.pdffiller.com/v2/fillable_forms \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'POST',
  url: 'https://api.pdffiller.com/v2/fillable_forms',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/fillable_forms")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.pdffiller.com/v2/fillable_forms");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/fillable_forms"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("POST", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

{
  "fillable_form_id": 123456,
  "document_name": "Document.pdf",
  "access": "full",
  "status": "public",
  "email_required": true,
  "allow_downloads": false,
  "redirect_url": "https://www.pdffiller.com",
  "name_required": true,
  "custom_message": "Some custom message",
  "filled_forms_count": 0,
  "notification_emails": [
    {
      "name": "Username",
      "email": "some-email@domain.com"
    }
  ],
  "notifications": "disabled",
  "sender_notifications": false,
  "url": "https://pdf.ac/aaa4a",
  "enforce_required_fields": true,
  "custom_logo_id": 1234,
  "welcome_screen": false,
  "additional_documents": [
    {
      "name": "docs1",
      "files": [
        {
          "id": 119031,
          "filename": "filename.pdf",
          "ip": "109.237.93.134",
          "date_created": "2017-03-10 10:06:33"
        }
      ]
    }
  ],
  "reusable": true,
  "callbacks": [
    {
      "event_id": "fill_request.done",
      "callback_url": "http://url.com",
      "document_id": 123456789
    }
  ],
  "signature_stamp": false,
  "field_wizard": "on",
  "user_tokens": [
    {
      "org_id": 11,
      "user_id": 111,
      "token": "Wye9HXrbeuJXQJCVAr3i0gr3M9SXAOy",
      "url": "https://pdf.ac/11AAA1?token=Wye9HXrbeuJXQJCVAr3i0gr3M9SXAOy"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Body Params

document_id

integer

required

Id of the document template. This field is required if file parameter is omitted.

additional_documents

array

Additional documents required after filling the document

signature_stamp

boolean

field_wizard

string

Fillable Form Input Status

On: displays fillable fields with wizard.
Off: displays fillable fields without wizard.
Disabled: disables fillable fields display.

access

string

Access level for the fill request document. Full - read|write|sign. Signature - read|sign.

status

string

Document access permission.

email_required

boolean

Email required

allow_downloads

boolean

Allow to download

redirect_url

string

Redirect uri

name_required

boolean

Name required

custom_message

string

LinkToFill custom message

notification_emails

array

LinkToFill notification emails

notifications

string

The notifications mode

sender_notifications

boolean

enforce_required_fields

boolean

Prevent closing document before filling all fields

custom_logo_id

integer

Document custom logo id

welcome_screen

boolean

Shows welcome agreement each time when user will open LinkToFill

reusable

boolean

After filling the form it will be copied to the owner as the fillable form

callback_url

string

editor_type

string

user_tokens

array of objects

required

org_id

user_id

token

url

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

Success - Information about created fill request item

fillable_form_id	integer Id of the document template for linkToFill operations
document_name	string The filename of the document template for linkToFill operations
access	string Access level for the fill request document. Full - read\|write\|sign. Signature - read\|sign.
status	string Document access permission.
email_required	boolean Email required
allow_downloads	boolean Allow to download
redirect_url	string Redirect uri
name_required	boolean Name required
custom_message	string LinkToFill custom message
filled_forms_count	integer Filled forms count
notification_emails	array LinkToFill notification emails
notifications	string The notifications mode
sender_notifications	boolean
url	string Document access url
enforce_required_fields	boolean Prevent closing document before filling all fields
custom_logo_id	integer Document custom logo id
welcome_screen	boolean Shows welcome agreement each time when user will open LinkToFill
additional_documents	array Additional documents required after filling the document. Max count 5.
reusable	boolean After filling the form it will be copied to the owner as the fillable form
callbacks	array
signature_stamp	boolean
field_wizard	string Fillable Form Input Status On: displays fillable fields with wizard. Off: displays fillable fields without wizard. Disabled: disables fillable fields display.
user_tokens	array

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Create Fillable Document uses the completed fields of an existing document to the fillable fields of a new LinkToFill document.

Creates a new document and shares it via short url.

posthttps://api.pdffiller.com/v2/fillable_forms

curl --request POST \
  --url https://api.pdffiller.com/v2/fillable_forms%20 \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'POST',
  url: 'https://api.pdffiller.com/v2/fillable_forms%20',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/fillable_forms%20")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.pdffiller.com/v2/fillable_forms%20");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/fillable_forms%20"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("POST", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

{
  "fillable_form_id": 123456,
  "document_name": "Document.pdf",
  "access": "full",
  "status": "public",
  "email_required": true,
  "allow_downloads": false,
  "redirect_url": "https://www.pdffiller.com",
  "name_required": true,
  "custom_message": "Some custom message",
  "filled_forms_count": 0,
  "notification_emails": [
    {
      "name": "Username",
      "email": "some-email@domain.com"
    }
  ],
  "notifications": "disabled",
  "sender_notifications": false,
  "url": "https://pdf.ac/aaa4a",
  "enforce_required_fields": true,
  "custom_logo_id": 1234,
  "welcome_screen": false,
  "additional_documents": [
    {
      "name": "docs1",
      "files": [
        {
          "id": 119031,
          "filename": "filename.pdf",
          "ip": "109.237.93.134",
          "date_created": "2017-03-10 10:06:33"
        }
      ]
    }
  ],
  "reusable": true,
  "callbacks": [
    {
      "event_id": "fill_request.done",
      "callback_url": "http://url.com",
      "document_id": 123456789
    }
  ],
  "signature_stamp": false,
  "field_wizard": "on",
  "user_tokens": [
    {
      "org_id": 11,
      "user_id": 111,
      "token": "Wye9HXrbeuJXQJCVAr3i0gr3M9SXAOy",
      "url": "https://pdf.ac/11AAA1?token=Wye9HXrbeuJXQJCVAr3i0gr3M9SXAOy"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Body Params

document_id

integer

required

Id of the document template. This field is required if file parameter is omitted.

fillable_fields

object

List of field(s) to be filled - does not apply to non-fillable documents.

fillable_fields.Key_N

string

Sets a field's fillable value by it's name (key).

name

string

folder_id

integer

additional_documents

array

Additional documents required after filling the document

access

string

Access level for the fill request document. Full - read|write|sign. Signature - read|sign.

status

string

Document access permission.

email_required

boolean

Email required

allow_downloads

boolean

Allow to download

redirect_url

string

Redirect uri

name_required

boolean

Name required

custom_message

string

LinkToFill custom message

notification_emails

array

LinkToFill notification emails

notifications

string

The notifications mode

sender_notifications

boolean

enforce_required_fields

boolean

Prevent closing document before filling all fields

custom_logo_id

integer

Document custom logo id

welcome_screen

boolean

Shows welcome agreement each time when user will open LinkToFill

reusable

boolean

After filling the form it will be copied to the owner as the fillable form

callback_url

string

editor_type

string

signature_stamp

boolean

user_tokens

array of objects

required

org_id

user_id

token

url

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

Success - Information about created fill request item

fillable_form_id	integer Id of the document template for linkToFill operations
document_name	string The filename of the document template for linkToFill operations
access	string Access level for the fill request document. Full - read\|write\|sign. Signature - read\|sign.
status	string Document access permission.
email_required	boolean Email required
allow_downloads	boolean Allow to download
redirect_url	string Redirect uri
name_required	boolean Name required
custom_message	string LinkToFill custom message
filled_forms_count	integer Filled forms count
notification_emails	array LinkToFill notification emails
notifications	string The notifications mode
sender_notifications	boolean
url	string Document access url
enforce_required_fields	boolean Prevent closing document before filling all fields
custom_logo_id	integer Document custom logo id
welcome_screen	boolean Shows welcome agreement each time when user will open LinkToFill
additional_documents	array Additional documents required after filling the document. Max count 5.
reusable	boolean After filling the form it will be copied to the owner as the fillable form
callbacks	array
signature_stamp	boolean
field_wizard	string Fillable Form Input Status On: displays fillable fields with wizard. Off: displays fillable fields without wizard. Disabled: disables fillable fields display.
user_tokens	array

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Create Fillable Document - Converts a downloaded document to a LinkToFill form

Creates a new document and shares it via short url.

posthttps://api.pdffiller.com/v2/fillable_forms

curl --request POST \
  --url https://api.pdffiller.com/v2/fillable_forms%20%20 \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'POST',
  url: 'https://api.pdffiller.com/v2/fillable_forms%20%20',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/fillable_forms%20%20")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.pdffiller.com/v2/fillable_forms%20%20");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/fillable_forms%20%20"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("POST", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

{
  "fillable_form_id": 123456,
  "document_name": "Document.pdf",
  "access": "full",
  "status": "public",
  "email_required": true,
  "allow_downloads": false,
  "redirect_url": "https://www.pdffiller.com",
  "name_required": true,
  "custom_message": "Some custom message",
  "filled_forms_count": 0,
  "notification_emails": [
    {
      "name": "Username",
      "email": "some-email@domain.com"
    }
  ],
  "notifications": "disabled",
  "sender_notifications": false,
  "url": "https://pdf.ac/aaa4a",
  "enforce_required_fields": true,
  "custom_logo_id": 1234,
  "welcome_screen": false,
  "additional_documents": [
    {
      "name": "docs1",
      "files": [
        {
          "id": 119031,
          "filename": "filename.pdf",
          "ip": "109.237.93.134",
          "date_created": "2017-03-10 10:06:33"
        }
      ]
    }
  ],
  "reusable": true,
  "callbacks": [
    {
      "event_id": "fill_request.done",
      "callback_url": "http://url.com",
      "document_id": 123456789
    }
  ],
  "signature_stamp": false,
  "field_wizard": "on",
  "user_tokens": [
    {
      "org_id": 11,
      "user_id": 111,
      "token": "Wye9HXrbeuJXQJCVAr3i0gr3M9SXAOy",
      "url": "https://pdf.ac/11AAA1?token=Wye9HXrbeuJXQJCVAr3i0gr3M9SXAOy"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Body Params

file

string

required

File to be uploaded. This field is required if document_id is omitted.

folder_id

integer

name

string

additional_documents

array

Additional documents required after filling the document

access

string

Access level for the fill request document. Full - read|write|sign. Signature - read|sign.

status

string

Document access permission.

email_required

boolean

Email required

allow_downloads

boolean

Allow to download

redirect_url

string

Redirect uri

name_required

boolean

Name required

custom_message

string

LinkToFill custom message

notification_emails

array

LinkToFill notification emails

notifications

string

The notifications mode

sender_notifications

boolean

enforce_required_fields

boolean

Prevent closing document before filling all fields

custom_logo_id

integer

Document custom logo id

welcome_screen

boolean

Shows welcome agreement each time when user will open LinkToFill

reusable

boolean

After filling the form it will be copied to the owner as the fillable form

callback_url

string

editor_type

string

signature_stamp

boolean

user_tokens

array of objects

required

org_id

user_id

token

url

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

Success - Information about created fill request item

fillable_form_id	integer Id of the document template for linkToFill operations
document_name	string The filename of the document template for linkToFill operations
access	string Access level for the fill request document. Full - read\|write\|sign. Signature - read\|sign.
status	string Document access permission.
email_required	boolean Email required
allow_downloads	boolean Allow to download
redirect_url	string Redirect uri
name_required	boolean Name required
custom_message	string LinkToFill custom message
filled_forms_count	integer Filled forms count
notification_emails	array LinkToFill notification emails
notifications	string The notifications mode
sender_notifications	boolean
url	string Document access url
enforce_required_fields	boolean Prevent closing document before filling all fields
custom_logo_id	integer Document custom logo id
welcome_screen	boolean Shows welcome agreement each time when user will open LinkToFill
additional_documents	array Additional documents required after filling the document. Max count 5.
reusable	boolean After filling the form it will be copied to the owner as the fillable form
callbacks	array
signature_stamp	boolean
field_wizard	string Fillable Form Input Status On: displays fillable fields with wizard. Off: displays fillable fields without wizard. Disabled: disables fillable fields display.
user_tokens	array

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Fill Form Information

Information about a created fill request item.

gethttps://api.pdffiller.com/v2/fillable_forms/link_to_fill_id

curl --request GET \
  --url https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("GET", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

{
  "fillable_form_id": 123456,
  "document_name": "Document.pdf",
  "access": "full",
  "status": "public",
  "email_required": true,
  "allow_downloads": false,
  "redirect_url": "https://www.pdffiller.com",
  "name_required": true,
  "custom_message": "Some custom message",
  "filled_forms_count": 0,
  "notification_emails": [
    {
      "name": "Username",
      "email": "some-email@domain.com"
    }
  ],
  "notifications": "disabled",
  "sender_notifications": false,
  "url": "https://pdf.ac/aaa4a",
  "enforce_required_fields": true,
  "custom_logo_id": 1234,
  "welcome_screen": false,
  "additional_documents": [
    {
      "name": "docs1",
      "files": [
        {
          "id": 119031,
          "filename": "filename.pdf",
          "ip": "109.237.93.134",
          "date_created": "2017-03-10 10:06:33"
        }
      ]
    }
  ],
  "reusable": true,
  "callbacks": [
    {
      "event_id": "fill_request.done",
      "callback_url": "http://url.com",
      "document_id": 123456789
    }
  ],
  "signature_stamp": false,
  "field_wizard": "on",
  "user_tokens": [
    {
      "org_id": 11,
      "user_id": 111,
      "token": "Wye9HXrbeuJXQJCVAr3i0gr3M9SXAOy",
      "url": "https://pdf.ac/11AAA1?token=Wye9HXrbeuJXQJCVAr3i0gr3M9SXAOy"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Path Params

link_to_fill_id

integer

required

Fill request Id.

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

Success

fillable_form_id	integer Id of the document template for linkToFill operations
document_name	string The filename of the document template for linkToFill operations
access	string Access level for the fill request document. Full - read\|write\|sign. Signature - read\|sign.
status	string Document access permission.
email_required	boolean Email required
allow_downloads	boolean Allow to download
redirect_url	string Redirect uri
name_required	boolean Name required
custom_message	string LinkToFill custom message
filled_forms_count	integer Filled forms count
notification_emails	array LinkToFill notification emails
notifications	string The notifications mode
sender_notifications	boolean
url	string Document access url
enforce_required_fields	boolean Prevent closing document before filling all fields
custom_logo_id	integer Document custom logo id
welcome_screen	boolean Shows welcome agreement each time when user will open LinkToFill
additional_documents	array Additional documents required after filling the document. Max count 5.
reusable	boolean After filling the form it will be copied to the owner as the fillable form
callbacks	array
signature_stamp	boolean
field_wizard	string Fillable Form Input Status On: displays fillable fields with wizard. Off: displays fillable fields without wizard. Disabled: disables fillable fields display.
user_tokens	array

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Updates Fillable Form

Updates a fill request item.

puthttps://api.pdffiller.com/v2/fillable_forms/link_to_fill_id

curl --request PUT \
  --url https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("PUT", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

{
  "fillable_form_id": 123456,
  "document_name": "Document.pdf",
  "access": "full",
  "status": "public",
  "email_required": true,
  "allow_downloads": false,
  "redirect_url": "https://www.pdffiller.com",
  "name_required": true,
  "custom_message": "Some custom message",
  "filled_forms_count": 0,
  "notification_emails": [
    {
      "name": "Username",
      "email": "some-email@domain.com"
    }
  ],
  "notifications": "disabled",
  "sender_notifications": false,
  "url": "https://pdf.ac/aaa4a",
  "enforce_required_fields": true,
  "custom_logo_id": 1234,
  "welcome_screen": false,
  "additional_documents": [
    {
      "name": "docs1",
      "files": [
        {
          "id": 119031,
          "filename": "filename.pdf",
          "ip": "109.237.93.134",
          "date_created": "2017-03-10 10:06:33"
        }
      ]
    }
  ],
  "reusable": true,
  "callbacks": [
    {
      "event_id": "fill_request.done",
      "callback_url": "http://url.com",
      "document_id": 123456789
    }
  ],
  "signature_stamp": false,
  "field_wizard": "on",
  "user_tokens": [
    {
      "org_id": 11,
      "user_id": 111,
      "token": "Wye9HXrbeuJXQJCVAr3i0gr3M9SXAOy",
      "url": "https://pdf.ac/11AAA1?token=Wye9HXrbeuJXQJCVAr3i0gr3M9SXAOy"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Path Params

link_to_fill_id

integer

required

Fill request Id.

Body Params

access

string

Access level for the fill request document. Full - read|write|sign. Signature - read|sign.

status

string

Document access permission.

email_required

boolean

Email required

allow_downloads

boolean

Allow to download

redirect_url

string

Redirect uri

name_required

boolean

Name required

custom_message

string

LinkToFill custom message

notification_emails

array

LinkToFill notification emails

notifications

string

The notifications mode

sender_notifications

boolean

enforce_required_fields

boolean

Prevent closing document before filling all fields

custom_logo_id

integer

Document custom logo id

welcome_screen

boolean

Shows welcome agreement each time when user will open LinkToFill

reusable

boolean

After filling the form it will be copied to the owner as the fillable form

signature_stamp

boolean

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

Success - Information about created fill request item

fillable_form_id	integer Id of the document template for linkToFill operations
document_name	string The filename of the document template for linkToFill operations
access	string Access level for the fill request document. Full - read\|write\|sign. Signature - read\|sign.
status	string Document access permission.
email_required	boolean Email required
allow_downloads	boolean Allow to download
redirect_url	string Redirect uri
name_required	boolean Name required
custom_message	string LinkToFill custom message
filled_forms_count	integer Filled forms count
notification_emails	array LinkToFill notification emails
notifications	string The notifications mode
sender_notifications	boolean
url	string Document access url
enforce_required_fields	boolean Prevent closing document before filling all fields
custom_logo_id	integer Document custom logo id
welcome_screen	boolean Shows welcome agreement each time when user will open LinkToFill
additional_documents	array Additional documents required after filling the document. Max count 5.
reusable	boolean After filling the form it will be copied to the owner as the fillable form
callbacks	array
signature_stamp	boolean
field_wizard	string Fillable Form Input Status On: displays fillable fields with wizard. Off: displays fillable fields without wizard. Disabled: disables fillable fields display.
user_tokens	array

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Deletes Fillable Form by id

Deletes a fill request item.

deletehttps://api.pdffiller.com/v2/fillable_forms/link_to_fill_id

curl --request DELETE \
  --url https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("DELETE", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

{
  "total": 0,
  "message": "string"
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Path Params

link_to_fill_id

integer

required

Fill request Id.

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

Success

total	integer
message	string

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Download All Filled Forms

You can easily export all the completed documents created via LinkToFill as a zip file. This method can give three statuses: Creating a Job with Job ID, Waiting (if zip is still in progress) or Zip content (if files ready to export).

gethttps://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/download

curl --request GET \
  --url https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/download \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/download',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/download")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/download");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/download"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("GET", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

undefined

{
  "job_id": "LpcXeqtHqZwIEookrQ2vmGqRzVpj4t23",
  "message": "Job has been successfully created",
  "callback_url": ""
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Path Params

link_to_fill_id

integer

required

Fill request Id.

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

OK

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

List Filled Forms for Fill Request

Lists all filled forms for the given fill request.

gethttps://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms

curl --request GET \
  --url https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("GET", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

{
  "total": 1,
  "current_page": 1,
  "per_page": 15,
  "prev_page_url": "string",
  "next_page_url": "string",
  "items": [
    {
      "filled_form_id": 123456,
      "document_id": 987654321,
      "name": "John",
      "email": "some@mail.com",
      "date": 1491983011,
      "ip": "255.255.255.255",
      "token": [
        {
          "id": 123,
          "hash": "some_hash_string",
          "data": [
            {
              "key_1": "Foo",
              "key_2": "Bar",
              "key_3": 12345
            }
          ]
        }
      ],
      "additional_documents": [
        {
          "name": "docs1",
          "files": [
            {
              "id": 119031,
              "filename": "filename.pdf",
              "ip": "109.237.93.134",
              "date_created": "2017-03-10 10:06:33"
            }
          ]
        }
      ],
      "reusable_document_id": 12345678,
      "signature_stamp": true
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Path Params

link_to_fill_id

integer

required

Fill request Id.

Query Params

per_page

integer

Filter by quantity of applications on the page

page

integer

Filter by page

order

string

Sort Method

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

Success

total	integer
current_page	integer
per_page	integer
prev_page_url	string
next_page_url	string
items	array

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Filled Form Information

Information about a specific filled form.

gethttps://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id

curl --request GET \
  --url https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("GET", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

{
  "filled_form_id": 123456,
  "document_id": 987654321,
  "name": "John",
  "email": "some@mail.com",
  "date": 1491983011,
  "ip": "255.255.255.255",
  "token": [
    {
      "id": 123,
      "hash": "some_hash_string",
      "data": [
        {
          "key_1": "Foo",
          "key_2": "Bar",
          "key_3": 12345
        }
      ]
    }
  ],
  "additional_documents": [
    {
      "name": "docs1",
      "files": [
        {
          "id": 119031,
          "filename": "filename.pdf",
          "ip": "109.237.93.134",
          "date_created": "2017-03-10 10:06:33"
        }
      ]
    }
  ],
  "reusable_document_id": 12345678,
  "signature_stamp": true
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Path Params

link_to_fill_id

integer

required

Fill Request ID.

filled_form_id

integer

required

Filled Form ID

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

Success

filled_form_id	integer Filled Form ID
document_id	integer Template ID for created filled form
name	string
email	string
date	integer
ip	string
token	array Attached token. Default value ''.
additional_documents	array Additional documents attached to request
reusable_document_id	integer An ID of reusable fillable document. Present if reusable option is enabled for related LinkToFill
signature_stamp	boolean

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Deletes Filled Form

Deletes a filled form.

deletehttps://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id

curl --request DELETE \
  --url https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("DELETE", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

{
  "total": 0,
  "message": "string"
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Path Params

link_to_fill_id

integer

required

Fill request Id.

filled_form_id

integer

required

Filled Form ID

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

Success

total	integer
message	string

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Exports Filled Form Data

Exports filled form data in one of the available formats: json, xls, xlsx, csv, html.

gethttps://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id/export

curl --request GET \
  --url https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id/export \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id/export',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id/export")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id/export");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id/export"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("GET", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

{
  "id": "161616",
  "email": "N/A",
  "name": "N/A",
  "date": "30/12/1999",
  "time": "12:59 pm",
  "total_pages": 0,
  "status": "NOT EMAILED",
  "pages": [
    {
      "integer": 1,
      "fillable_fields_num": 5,
      "prefilled_content_num": 0,
      "fillable_fields": [
        {
          "name": "text_1",
          "content": ""
        }
      ]
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Path Params

link_to_fill_id

integer

required

Fill request Id.

filled_form_id

integer

required

Filled Form ID

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

Success

id	string
email	string
name	string
date	string
time	string
total_pages	integer
status	string
pages	array

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Download Filled PDF Form

Downloads a filled PDF form.

gethttps://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id/download

curl --request GET \
  --url https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id/download \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id/download',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id/download")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id/download");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id/download"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("GET", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

undefined

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Path Params

link_to_fill_id

integer

required

Fill request Id.

filled_form_id

integer

required

Filled Form ID

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

OK

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

List Recipient`s Attached Additional Documents

Returns a list of a LinkToFill recipient`s attached additional documents.

gethttps://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id/additional_documents

curl --request GET \
  --url https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id/additional_documents \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id/additional_documents',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id/additional_documents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id/additional_documents");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id/additional_documents"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("GET", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

{
  "items": [
    {
      "name": "docs1",
      "files": [
        {
          "id": 119031,
          "filename": "filename.pdf",
          "ip": "109.237.93.134",
          "date_created": "2017-03-10 10:06:33"
        }
      ]
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Path Params

link_to_fill_id

integer

required

Fill request Id.

filled_form_id

integer

required

Filled Form ID

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

Success

items	array

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

List Information of Recipient`s Attached Additional Document

Returns information about one LinkToFill recipient`s attached additional document.

gethttps://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id/additional_documents/additional_document_id

curl --request GET \
  --url https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id/additional_documents/additional_document_id \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id/additional_documents/additional_document_id',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id/additional_documents/additional_document_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id/additional_documents/additional_document_id");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id/additional_documents/additional_document_id"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("GET", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

{
  "id": 123,
  "filename": "filename",
  "ip": "255.255.255.255",
  "date_created": 1491982463
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Path Params

link_to_fill_id

integer

required

Fill request Id.

filled_form_id

integer

required

Filled Form ID.

additional_document_id

integer

required

Attached additional document ID

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

Success

id	integer Read only field. Not used in post\|put operations
filename	string Filename of an additional document. Read only field. Not used in post\|put operations
ip	string Read only field. Not used in post\|put operations
date_created	integer Read only field. Not used in post\|put operations

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Download Filled Form`s Additional Document

Downloads a file of a LinkToFill filled form`s additional document.

gethttps://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id/additional_documents/additional_document_id/download

curl --request GET \
  --url https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id/additional_documents/additional_document_id/download \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id/additional_documents/additional_document_id/download',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id/additional_documents/additional_document_id/download")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id/additional_documents/additional_document_id/download");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id/additional_documents/additional_document_id/download"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("GET", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

undefined

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Path Params

link_to_fill_id

integer

required

Fill request Id.

filled_form_id

integer

required

Filled Form ID.

additional_document_id

integer

required

Attached additional document ID

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

OK

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Download All Filled Form`s Additional Documents

Downloads a zip-file of all LinkToFill filled form`s additional documents. This method can give three statuses: Creating a Job with Job ID, Waiting (if zip is still in progress) or Zip content (if files ready to export).

gethttps://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id/additional_documents/download

curl --request GET \
  --url https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id/additional_documents/download \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id/additional_documents/download',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id/additional_documents/download")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id/additional_documents/download");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/fillable_forms/link_to_fill_id/filled_forms/filled_form_id/additional_documents/download"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("GET", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

undefined

{
  "job_id": "LpcXeqtHqZwIEookrQ2vmGqRzVpj4t23",
  "message": "Job has been successfully created",
  "callback_url": ""
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Path Params

link_to_fill_id

integer

required

Fill request Id.

filled_form_id

integer

required

Filled Form ID.

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

OK

Tokens

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

List All Tokens

Returns a list of all tokens.

gethttps://api.pdffiller.com/v2/tokens

curl --request GET \
  --url https://api.pdffiller.com/v2/tokens \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.pdffiller.com/v2/tokens',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/tokens")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.pdffiller.com/v2/tokens");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/tokens"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("GET", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

{
  "total": 1,
  "current_page": 1,
  "per_page": 15,
  "prev_page_url": "string",
  "next_page_url": "string",
  "items": [
    {
      "id": 123,
      "hash": "some_hash_string",
      "data": [
        {
          "key_1": "Foo",
          "key_2": "Bar",
          "key_3": 12345
        }
      ]
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Query Params

per_page

integer

Filter by quantity of tokens on the page

page

integer

Filter by page

order_by

string

Filter for sort by selected property

order

string

Sort Method

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

Success

total	integer
current_page	integer
per_page	integer
prev_page_url	string
next_page_url	string
items	array

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Creates New Token

Creates a new token.

posthttps://api.pdffiller.com/v2/tokens

curl --request POST \
  --url https://api.pdffiller.com/v2/tokens \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'POST',
  url: 'https://api.pdffiller.com/v2/tokens',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/tokens")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.pdffiller.com/v2/tokens");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/tokens"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("POST", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

{
  "id": 123,
  "hash": "some_hash_string",
  "data": [
    {
      "key_1": "Foo",
      "key_2": "Bar",
      "key_3": 12345
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Body Params

data

array of objects

required

Custom information attached to the token

key_1

key_2

key_3

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

Success - Information about created token

id	integer
hash	string Token hash value
data	array Custom information attached to the token

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Created Token Information

Information about a created token.

gethttps://api.pdffiller.com/v2/tokens/token_id

curl --request GET \
  --url https://api.pdffiller.com/v2/tokens/token_id \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.pdffiller.com/v2/tokens/token_id',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/tokens/token_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.pdffiller.com/v2/tokens/token_id");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/tokens/token_id"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("GET", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

{
  "id": 123,
  "hash": "some_hash_string",
  "data": [
    {
      "key_1": "Foo",
      "key_2": "Bar",
      "key_3": 12345
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Path Params

token_id

string

required

Token Id

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

Success

id	integer
hash	string Token hash value
data	array Custom information attached to the token

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Update Token

Updates a token.

puthttps://api.pdffiller.com/v2/tokens/token_id

curl --request PUT \
  --url https://api.pdffiller.com/v2/tokens/token_id%20 \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.pdffiller.com/v2/tokens/token_id%20',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/tokens/token_id%20")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.pdffiller.com/v2/tokens/token_id%20");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/tokens/token_id%20"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("PUT", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

{
  "id": 123,
  "hash": "some_hash_string",
  "data": [
    {
      "key_1": "Foo",
      "key_2": "Bar",
      "key_3": 12345
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Path Params

token_id

string

required

Token Id

Body Params

data

array of objects

required

Custom information attached to the token

key_1

key_2

key_3

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

Success - Information about updated token

id	integer
hash	string Token hash value
data	array Custom information attached to the token

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Delete Token

Deletes a token item.

deletehttps://api.pdffiller.com/v2/tokens/token_id

curl --request DELETE \
  --url https://api.pdffiller.com/v2/tokens/token_id%20%20 \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.pdffiller.com/v2/tokens/token_id%20%20',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/tokens/token_id%20%20")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.pdffiller.com/v2/tokens/token_id%20%20");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/tokens/token_id%20%20"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("DELETE", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

{
  "total": 0,
  "message": "string"
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Path Params

token_id

integer

required

Token Id.

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

Success

total	integer
message	string

Organizations

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

List All Organizations

Retrieves a list of organizations.

gethttps://api.pdffiller.com/v2/organizations

curl --request GET \
  --url https://api.pdffiller.com/v2/organizations \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.pdffiller.com/v2/organizations',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/organizations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.pdffiller.com/v2/organizations");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/organizations"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("GET", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

{
  "total": 1,
  "current_page": 1,
  "per_page": 15,
  "prev_page_url": "string",
  "next_page_url": "string",
  "items": [
    {
      "id": 123456,
      "name": "My company",
      "users_count": 100
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Query Params

per_page

integer

Filter by quantity of organizations on the page

page

integer

Filter by page

order

string

Sort Method

order_by

string

Filter for sort by custom property

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

Success - list of organizations

total	integer
current_page	integer
per_page	integer
prev_page_url	string
next_page_url	string
items	array

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Create A New Organization

Creates a new organization. The organization name must contain integers, English letters or special characters: ( ) _ .

posthttps://api.pdffiller.com/v2/organizations

curl --request POST \
  --url https://api.pdffiller.com/v2/organizations \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'POST',
  url: 'https://api.pdffiller.com/v2/organizations',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/organizations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.pdffiller.com/v2/organizations");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/organizations"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("POST", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

{
  "id": 123456,
  "name": "My company",
  "users_count": 100
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Body Params

name

string

required

Name of the organization

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

Success - Information about created organization

id	integer Id of the organization
name	string Name of the organization
users_count	integer Users in the organization

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Organization Information

Retrieves information about created organization.

gethttps://api.pdffiller.com/v2/organizations/organization_id

curl --request GET \
  --url https://api.pdffiller.com/v2/organizations/organization_id \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'GET',
  url: 'https://api.pdffiller.com/v2/organizations/organization_id',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/organizations/organization_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.pdffiller.com/v2/organizations/organization_id");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/organizations/organization_id"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("GET", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

{
  "id": 123456,
  "name": "My company",
  "users_count": 100
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Path Params

organization_id

integer

required

Id of the organization.

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

Success - Information about created organization

id	integer Id of the organization
name	string Name of the organization
users_count	integer Users in the organization

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Updates Organization Name

Updates the organization's name.

puthttps://api.pdffiller.com/v2/organizations/organization_id

curl --request PUT \
  --url https://api.pdffiller.com/v2/organizations/organization_id%20 \
  --header 'authorization: Bearer AccessToken'

var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.pdffiller.com/v2/organizations/organization_id%20',
  headers: { authorization: 'Bearer AccessToken' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://api.pdffiller.com/v2/organizations/organization_id%20")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["authorization"] = 'Bearer AccessToken'

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.pdffiller.com/v2/organizations/organization_id%20");
xhr.setRequestHeader("authorization", "Bearer AccessToken");

xhr.send(data);

import requests

url = "https://api.pdffiller.com/v2/organizations/organization_id%20"

headers = {'authorization': 'Bearer AccessToken'}

response = requests.request("PUT", url, headers=headers)

print(response.text)

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

{
  "id": 123456,
  "name": "My company",
  "users_count": 100
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "id": "string"
    }
  ]
}

Path Params

organization_id

integer

required

Id of the organization.

Body Params

name

string

required

Headers

Authorization

string

required

Bearer Access Token obtained from client credentials

Response

Success - Information about changed organization

id	integer Id of the organization
name	string Name of the organization
users_count	integer Users in the organization