PingOne Platform APIs

Export Form

POST {{apiPath}}/v1/environments/{{envID}}/forms/{{formID}}

The POST {{apiPath}}/v1/environments/{environmentID}/forms/{{formID}} operation exports the form resource identified by its ID in the request URL. To use the POST for an export action, the request must include an HTTP Content-Type header set to application/vnd.pingidentity.form.export+json. A form export action returns essential form configuration data while stripping out custom attributes, fieldTypes, and languageBundle to provide a reduced response payload.

Headers

Authorization      Bearer {{accessToken}}

Content-Type      application/vnd.pingidentity.form.export+json

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff --request POST '{{apiPath}}/v1/environments/{{envID}}/forms/{{formID}}' \
--header 'Content-Type: application/vnd.pingidentity.form.export+json' \
--header 'Authorization: Bearer {{accessToken}}'
var options = new RestClientOptions("{{apiPath}}/v1/environments/{{envID}}/forms/{{formID}}")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/vnd.pingidentity.form.export+json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "{{apiPath}}/v1/environments/{{envID}}/forms/{{formID}}"
  method := "POST"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/vnd.pingidentity.form.export+json")
  req.Header.Add("Authorization", "Bearer {{accessToken}}")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}
POST /v1/environments/{{envID}}/forms/{{formID}} HTTP/1.1
Host: {{apiPath}}
Content-Type: application/vnd.pingidentity.form.export+json
Authorization: Bearer {{accessToken}}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/vnd.pingidentity.form.export+json");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("{{apiPath}}/v1/environments/{{envID}}/forms/{{formID}}")
  .method("POST", body)
  .addHeader("Content-Type", "application/vnd.pingidentity.form.export+json")
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/v1/environments/{{envID}}/forms/{{formID}}",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/vnd.pingidentity.form.export+json",
    "Authorization": "Bearer {{accessToken}}"
  },
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'POST',
  'url': '{{apiPath}}/v1/environments/{{envID}}/forms/{{formID}}',
  'headers': {
    'Content-Type': 'application/vnd.pingidentity.form.export+json',
    'Authorization': 'Bearer {{accessToken}}'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
import requests
import json

url = "{{apiPath}}/v1/environments/{{envID}}/forms/{{formID}}"

payload = {}
headers = {
  'Content-Type': 'application/vnd.pingidentity.form.export+json',
  'Authorization': 'Bearer {{accessToken}}'
}

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

print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/v1/environments/{{envID}}/forms/{{formID}}');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Content-Type' => 'application/vnd.pingidentity.form.export+json',
  'Authorization' => 'Bearer {{accessToken}}'
));
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}
require "uri"
require "json"
require "net/http"

url = URI("{{apiPath}}/v1/environments/{{envID}}/forms/{{formID}}")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/vnd.pingidentity.form.export+json"
request["Authorization"] = "Bearer {{accessToken}}"

response = http.request(request)
puts response.read_body
var request = URLRequest(url: URL(string: "{{apiPath}}/v1/environments/{{envID}}/forms/{{formID}}")!,timeoutInterval: Double.infinity)
request.addValue("application/vnd.pingidentity.form.export+json", forHTTPHeaderField: "Content-Type")
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")

request.httpMethod = "POST"

let task = URLSession.shared.dataTask(with: request) { data, response, error in
  guard let data = data else {
    print(String(describing: error))
    return
  }
  print(String(data: data, encoding: .utf8)!)
}

task.resume()

Example Response

200 OK

{
    "id": "c8840e54-3d88-4724-a83e-245ae1275bbe",
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "name": "Agreement",
    "description": "Prompt the user to read and consent to an agreement, such as a Terms of Service.",
    "category": "CUSTOM",
    "components": {
        "fields": [
            {
                "position": {
                    "row": 0,
                    "col": 0
                },
                "key": "agreement",
                "agreement": {
                    "useDynamicAgreement": true
                },
                "inputType": "READ_ONLY_TEXT",
                "titleEnabled": true,
                "type": "AGREEMENT"
            },
            {
                "type": "ERROR_DISPLAY",
                "position": {
                    "row": 1,
                    "col": 0
                }
            },
            {
                "position": {
                    "row": 2,
                    "col": 0
                },
                "label": "[{\"type\":\"paragraph\",\"children\":[{\"text\":\"Accept\"}]}]",
                "type": "SUBMIT_BUTTON"
            },
            {
                "position": {
                    "row": 3,
                    "col": 0
                },
                "label": "[{\"type\":\"paragraph\",\"children\":[{\"text\":\"Decline\"}]}]",
                "key": "decline-link",
                "type": "FLOW_LINK"
            }
        ]
    },
    "cols": 4,
    "markOptional": true,
    "markRequired": false,
    "textAutoCompleteEnabled": false,
    "passwordAutoCompleteEnabled": false,
    "translationMethod": "TRANSLATE",
    "created": "2026-01-28T18:35:00.550Z",
    "modified": "2026-01-28T18:35:00.550Z",
    "readOnly": false
}