Get Data Request

Fetch a data request to check the status.

HTTP Request



You must send an Authorization header with the value Basic followed by base 64 encoded token_id:token_secret.

For example: Authorization: Basic dG9rZW5faWQ6dG9rZW5fc2VjcmV0Cg==

See the Authentication documentation for more information.

Example Response

  "id": "drq_000000000000000001",
  "email": "[email protected]",
  "name": "John Doe",
  "order": 1,
  "fields": ["description"],
  "metadata": {
    "user_id": 42
  "state": "complete",
  "viewed_at": "2018-10-23T13:00:00Z",
  "completed_at": "2018-10-23T13:05:00Z"

Example Code

var FormAPI = require("formapi");

client = new FormAPI.Client(config);

client.getDataRequest("drq_000000000000000001", function(error, dataRequest) {
  if (error) throw error;
require 'form_api'

formapi =

data_request = formapi.get_data_request('drq_000000000000000001')
puts data_request
import form_api

client = form_api.Client()
data_request = client.get_data_request("drq_000000000000000001")
$formapi = new FormAPI\Client();
$data_request_id = 'drq_000000000000000001';
$data_request = $formapi->getDataRequest($data_request_id);
echo $data_request;
using System;
using System.Diagnostics;
using FormApi.Client.Api;
using FormApi.Client.Client;
using FormApi.Client.Model;

namespace Example
    public class FormAPIExample
        public void main()
          var apiInstance = new PDFApi();
          string dataRequestId = "drq_000000000000000001";
          var data_request = apiInstance.GetDataRequest(dataRequestId);
export DATA_REQUEST_ID="drq_000000000000000001"

curl -s "$DATA_REQUEST_ID" \

results matching ""

    No results matching ""