Read Forms

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

The GET {{apiPath}}/environments/{environmentID}/forms operation returns data for all forms resources in the environment resource identified by its ID in the request URL.

Headers

Authorization Bearer {{accessToken}}

Example Request

curl --location --globoff '{{apiPath}}/environments/{{envID}}/forms' \
--header 'Authorization: Bearer {{accessToken}}'

var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/forms")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Get);
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"
  method := "GET"

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

  if err != nil {
    fmt.Println(err)
    return
  }
  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 HTTP/1.1
Host: {{apiPath}}
Authorization: Bearer {{accessToken}}

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/forms")
  .method("GET", body)
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();

var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/forms",
  "method": "GET",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer {{accessToken}}"
  },
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

var request = require('request');
var options = {
  'method': 'GET',
  'url': '{{apiPath}}/environments/{{envID}}/forms',
  'headers': {
    'Authorization': 'Bearer {{accessToken}}'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

import requests

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

payload = {}
headers = {
  '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');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  '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 "net/http"

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

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer {{accessToken}}"

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

var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/forms")!,timeoutInterval: Double.infinity)
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"
        }
    },
    "_embedded": {
        "forms": [
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/forms/1ab9b4ce-b86a-464b-8854-a0401d31f272"
                    }
                },
                "id": "1ab9b4ce-b86a-464b-8854-a0401d31f272",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "name": "Registration-Form_1624399502",
                "category": "CUSTOM",
                "cols": 4,
                "markOptional": true,
                "markRequired": false,
                "translationMethod": "TRANSLATE",
                "fieldTypes": [
                    "SUBMIT_BUTTON",
                    "TEXT",
                    "TEXTBLOB",
                    "PASSWORD_VERIFY"
                ],
                "created": "2021-06-22T22:05:02.450Z",
                "modified": "2023-03-14T22:10:23.865Z"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/forms/28291677-d501-42f7-9732-537b9a1f5e09"
                    }
                },
                "id": "28291677-d501-42f7-9732-537b9a1f5e09",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "name": "Registration-Form_1627495647",
                "category": "CUSTOM",
                "cols": 4,
                "markOptional": true,
                "markRequired": false,
                "translationMethod": "TRANSLATE",
                "fieldTypes": [
                    "SUBMIT_BUTTON",
                    "TEXT",
                    "TEXTBLOB",
                    "PASSWORD_VERIFY"
                ],
                "created": "2021-07-28T18:07:26.945Z",
                "modified": "2023-03-14T22:10:24.011Z"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/forms/2bbd21e1-03ad-4b30-9837-9ca59e8f30be"
                    }
                },
                "id": "2bbd21e1-03ad-4b30-9837-9ca59e8f30be",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "name": "Registration-Form_1629844412",
                "category": "CUSTOM",
                "cols": 4,
                "markOptional": true,
                "markRequired": false,
                "translationMethod": "TRANSLATE",
                "fieldTypes": [
                    "SUBMIT_BUTTON",
                    "TEXT",
                    "TEXTBLOB",
                    "PASSWORD_VERIFY"
                ],
                "created": "2021-08-24T22:33:32.764Z",
                "modified": "2023-03-14T22:10:24.168Z"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/forms/6148fefd-d5f3-402d-8b34-43ebcab42f61"
                    }
                },
                "id": "6148fefd-d5f3-402d-8b34-43ebcab42f61",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "name": "Custom-Form_Updated_1679528952",
                "category": "CUSTOM",
                "cols": 4,
                "markOptional": true,
                "markRequired": false,
                "fieldTypes": [
                    "SUBMIT_BUTTON",
                    "TEXT",
                    "TEXTBLOB"
                ],
                "created": "2023-03-22T23:48:26.995Z",
                "modified": "2023-03-22T23:49:12.173Z"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/forms/adc05c92-dd0c-4ac9-b25a-94b863a90c70"
                    }
                },
                "id": "adc05c92-dd0c-4ac9-b25a-94b863a90c70",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "name": "Custom-Form_Updated_1679937043",
                "category": "CUSTOM",
                "cols": 4,
                "markOptional": true,
                "markRequired": false,
                "translationMethod": "TRANSLATE",
                "fieldTypes": [
                    "SUBMIT_BUTTON",
                    "TEXT"
                ],
                "languageBundle": {
                    "fields.user.email.label": "Email Address",
                    "button.text": "Submit"
                },
                "created": "2023-03-27T17:07:22.410Z",
                "modified": "2023-03-27T17:10:42.818Z"
            }
        ]
    },
    "size": 5
}