Read One Experience by Name

GET {{apiPath}}/v1/environments/{{envID}}/experiences?name={{experienceName}}

Use GET {{apiPath}}/v1/environments/{{envID}}/experiences?name="{{experienceName}}" to return the user experience specified by the name.

Headers

Authorization Bearer {{accessToken}}

Example Request

curl --location --globoff '{{apiPath}}/v1/environments/{{envID}}/experiences?name={{experienceName}}' \
--header 'Authorization: Bearer {{accessToken}}'

var options = new RestClientOptions("{{apiPath}}/v1/environments/{{envID}}/experiences?name={{experienceName}}")
{
  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}}/v1/environments/{{envID}}/experiences?name={{experienceName}}"
  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 /v1/environments/{{envID}}/experiences?name={{experienceName}} 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}}/v1/environments/{{envID}}/experiences?name={{experienceName}}")
  .method("GET", body)
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();

var settings = {
  "url": "{{apiPath}}/v1/environments/{{envID}}/experiences?name={{experienceName}}",
  "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}}/v1/environments/{{envID}}/experiences?name={{experienceName}}',
  'headers': {
    'Authorization': 'Bearer {{accessToken}}'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

import requests

url = "{{apiPath}}/v1/environments/{{envID}}/experiences?name={{experienceName}}"

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}}/v1/environments/{{envID}}/experiences?name={{experienceName}}');
$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}}/v1/environments/{{envID}}/experiences?name={{experienceName}}")

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}}/v1/environments/{{envID}}/experiences?name={{experienceName}}")!,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": {
        "environment": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
        },
        "self": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/experiences"
        }
    },
    "_embedded": {
        "experiences": [
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/experiences/939fed4a-90d3-4895-bf0d-ac8c30ba85f8"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "theme": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/themes/5ab94557-59c3-4afc-bbf6-046444bd04b8"
                    },
                    "mfa.accessPolicies.0": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/deviceAuthenticationPolicies/f3ebf6b8-9902-4421-af59-54b1b99969fa"
                    },
                    "mfa.enrollment.policies.0": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/deviceAuthenticationPolicies/policy-id"
                    },
                    "population": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/populations/89a7de36-c2ce-48d6-b453-9d7a7dd4dc3a"
                    },
                    "termsOfServiceAgreement": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/agreements/363ef235-f6fe-4bc7-ae3d-63217482f57f"
                    }
                },
                "id": "939fed4a-90d3-4895-bf0d-ac8c30ba85f8",
                "name": "userPasswordFlow1",
                "description": "",
                "flowType": "USERNAME_AND_PASSWORD",
                "firstFactor": {
                    "passwordless": {
                        "enabled": false,
                        "usernameFirst": false,
                        "passkeyPolicies": []
                    },
                    "passkeyOrBioMetric": {
                        "enabled": false,
                        "passkeyPolicies": []
                    },
                    "identityProviders": {
                        "enabled": false,
                        "socialProviders": []
                    },
                    "rememberMe": true,
                    "sessionTimeout": {
                        "unit": "HH",
                        "value": "128",
                        "enabled": true
                    }
                },
                "mfa": {
                    "enabled": true,
                    "accessPolicies": [
                        {
                            "id": "f3ebf6b8-9902-4421-af59-54b1b99969fa",
                            "type": "STANDARD_MFA"
                        }
                    ],
                    "sessionTimeout": {
                        "unit": "HH",
                        "value": "128",
                        "enabled": true
                    },
                    "enrollment": {
                        "enabled": false,
                        "required": false,
                        "policies": [
                            {
                                "id": "policy-id",
                                "type": "STANDARD_MFA"
                            }
                        ]
                    }
                },
                "accountRecovery": {
                    "enabled": false,
                    "accessPolicies": []
                },
                "registration": {
                    "enabled": true,
                    "attributeList": [
                        {
                            "name": "email",
                            "required": true
                        },
                        {
                            "name": "password",
                            "required": true
                        }
                    ],
                    "botDetection": {
                        "enabled": false,
                        "accessPolicies": []
                    },
                    "termsOfService": {
                        "enabled": true,
                        "agreementPolicy": {
                            "id": "363ef235-f6fe-4bc7-ae3d-63217482f57f"
                        }
                    },
                    "requireAccountVerification": true,
                    "population": {
                        "id": "89a7de36-c2ce-48d6-b453-9d7a7dd4dc3a"
                    }
                },
                "theme": {
                    "id": "5ab94557-59c3-4afc-bbf6-046444bd04b8"
                },
                "createdAt": "2026-05-11T11:25:49.455Z",
                "updatedAt": "2026-05-11T11:25:49.455Z"
            }
        ]
    },
    "size": 1
}