PingOne Platform APIs

Export Form

 

GET {{apiPath}}/environments/{{envID}}/forms/{{formID}}

The GET {{apiPath}}/environments/{environmentID}/forms/{{formID}} operation exports the form resource identified by its ID in the request URL. To use the GET 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 the language bundle 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 '{{apiPath}}/environments/{{envID}}/forms/{{formID}}' \
--header 'Content-Type: application/vnd.pingidentity.form.export+json' \
--header 'Authorization: Bearer {{accessToken}}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/forms/{{formID}}")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Get);
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}}/environments/{{envID}}/forms/{{formID}}"
  method := "GET"

  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))
}
GET /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}}/environments/{{envID}}/forms/{{formID}}")
  .method("GET", 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}}/environments/{{envID}}/forms/{{formID}}",
  "method": "GET",
  "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': 'GET',
  'url': '{{apiPath}}/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}}/environments/{{envID}}/forms/{{formID}}"

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

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

print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/environments/{{envID}}/forms/{{formID}}');
$request->setMethod(HTTP_Request2::METHOD_GET);
$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}}/environments/{{envID}}/forms/{{formID}}")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.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}}/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 = "GET"

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

{
    "_links": {
        "self": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/forms/2972873e-444f-4973-be77-a51324e10b95"
        },
        "identityProviders.social-login-button-field": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/identityProviders/69f5ef8d-60ce-48a7-9ede-1579b41c6af7"
        }
    },
    "id": "2972873e-444f-4973-be77-a51324e10b95",
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "name": "Custom-Form_1758146427",
    "category": "CUSTOM",
    "components": {
        "fields": [
            {
                "type": "TEXT",
                "position": {
                    "row": 0,
                    "col": 0
                },
                "visibility": {
                    "type": "SHOW_BY_DEFAULT",
                    "key": "some-key"
                },
                "key": "field",
                "label": "[{\"type\":\"paragraph\",\"children\":[{\"text\":\"\"},{\"type\":\"i18n\",\"key\":\"fields.user.email.label\",\"defaultTranslation\":\"Email Address\",\"inline\":true,\"children\":[{\"text\":\"\"}]},{\"text\":\"\"}]}]",
                "required": true,
                "validation": {
                    "type": "NONE",
                    "regex": "",
                    "errorMessage": ""
                },
                "otherOptionEnabled": false,
                "otherOptionAttributeDisabled": false,
                "attributeDisabled": false
            },
            {
                "type": "SOCIAL_LOGIN_BUTTON",
                "position": {
                    "row": 1,
                    "col": 0
                },
                "key": "social-login-button-field",
                "label": "Sign in with Google",
                "styles": {
                    "width": 100,
                    "alignment": "CENTER",
                    "displayDefaultThemeButtonBackgroundColor": false,
                    "displayDefaultThemeButtonBorderColor": false,
                    "displayDefaultThemeButtonTextColor": false,
                    "enabled": false
                },
                "idpType": "GOOGLE",
                "idpName": "Google",
                "idpId": "69f5ef8d-60ce-48a7-9ede-1579b41c6af7",
                "idpEnabled": true
            },
            {
                "type": "SUBMIT_BUTTON",
                "position": {
                    "row": 2,
                    "col": 0
                },
                "label": "[{\"type\":\"paragraph\",\"children\":[{\"text\":\"\"},{\"type\":\"i18n\",\"key\":\"button.text\",\"defaultTranslation\":\"Submit\",\"inline\":true,\"children\":[{\"text\":\"\"}]},{\"text\":\"\"}]}]"
            }
        ]
    },
    "cols": 4,
    "markOptional": true,
    "markRequired": false,
    "textAutoCompleteEnabled": false,
    "passwordAutoCompleteEnabled": false,
    "translationMethod": "TRANSLATE",
    "fieldTypes": [
        "SUBMIT_BUTTON",
        "TEXT",
        "SOCIAL_LOGIN_BUTTON"
    ],
    "languageBundle": {
        "fields.user.email.label": "Email Address",
        "button.text": "Submit"
    },
    "created": "2025-09-17T22:00:28.061Z",
    "modified": "2025-09-17T22:00:28.061Z"
}