Step 3: Get languages

GET {{apiPath}}/environments/{{envID}}/languages

The GET /environments/{{envID}}/languages returns a list of all languages associated with the specified environment, including the environment’s default language. An agreement can be enabled only if there is agreement revision content in the environment’s default language.

In the Postman collection for this workflow, the request includes a test script that finds your environment’s default language and uses it as the agreement language to create the agreement revision content. By setting the agreement revision language to the environment’s default language, this action allows you to enable the agreement.

Headers

Authorization Bearer {{accessToken}}

Example Request

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

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

var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/languages",
  "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}}/languages',
  '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}}/languages"

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}}/languages');
$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}}/languages")

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}}/languages")!,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/languages"
        }
    },
    "_embedded": {
        "languages": [
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/0ab426ad-2518-4b5c-bce2-664a626ce52b"
                    },
                    "status": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/0ab426ad-2518-4b5c-bce2-664a626ce52b/status"
                    }
                },
                "id": "0ab426ad-2518-4b5c-bce2-664a626ce52b",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "locale": "zh",
                "name": "Chinese",
                "enabled": false,
                "customerAdded": false,
                "createdAt": "2025-10-30T18:37:01.501Z",
                "updatedAt": "2025-10-30T18:37:01.501Z",
                "default": false
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/770df975-979f-4052-8f7a-9634c8aedf4e"
                    },
                    "status": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/770df975-979f-4052-8f7a-9634c8aedf4e/status"
                    }
                },
                "id": "770df975-979f-4052-8f7a-9634c8aedf4e",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "locale": "cs",
                "name": "Czech",
                "enabled": false,
                "customerAdded": false,
                "createdAt": "2025-10-30T18:37:01.503Z",
                "updatedAt": "2025-10-30T18:37:01.503Z",
                "default": false
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/32e9b4e1-ff74-4c4f-aa43-9454a8cd6398"
                    },
                    "status": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/32e9b4e1-ff74-4c4f-aa43-9454a8cd6398/status"
                    }
                },
                "id": "32e9b4e1-ff74-4c4f-aa43-9454a8cd6398",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "locale": "nl",
                "name": "Dutch",
                "enabled": false,
                "customerAdded": false,
                "createdAt": "2025-10-30T18:37:01.508Z",
                "updatedAt": "2025-10-30T18:37:01.508Z",
                "default": false
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/5673ed79-516c-43ee-bf11-0d8df7e6fee8"
                    },
                    "status": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/5673ed79-516c-43ee-bf11-0d8df7e6fee8/status"
                    }
                },
                "id": "5673ed79-516c-43ee-bf11-0d8df7e6fee8",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "locale": "en",
                "name": "English",
                "enabled": true,
                "customerAdded": false,
                "createdAt": "2025-10-30T18:37:01.492Z",
                "updatedAt": "2025-10-30T18:37:01.492Z",
                "default": true
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/e13e4cdf-c6d6-43d6-b7e4-d0c969d57575"
                    },
                    "status": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/e13e4cdf-c6d6-43d6-b7e4-d0c969d57575/status"
                    }
                },
                "id": "e13e4cdf-c6d6-43d6-b7e4-d0c969d57575",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "locale": "fr",
                "name": "French",
                "enabled": false,
                "customerAdded": false,
                "createdAt": "2025-10-30T18:37:01.495Z",
                "updatedAt": "2025-10-30T18:37:01.495Z",
                "default": false
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/42d8ce7f-83ff-4ab1-a5b6-35d61dcfe0b6"
                    },
                    "status": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/42d8ce7f-83ff-4ab1-a5b6-35d61dcfe0b6/status"
                    }
                },
                "id": "42d8ce7f-83ff-4ab1-a5b6-35d61dcfe0b6",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "locale": "fr-CA",
                "name": "French (Canada)",
                "enabled": false,
                "customerAdded": false,
                "createdAt": "2025-10-30T18:37:01.500Z",
                "updatedAt": "2025-10-30T18:37:01.500Z",
                "default": false
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/d7bdc9f4-9b8b-46b5-8a03-139c0e9254c2"
                    },
                    "status": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/d7bdc9f4-9b8b-46b5-8a03-139c0e9254c2/status"
                    }
                },
                "id": "d7bdc9f4-9b8b-46b5-8a03-139c0e9254c2",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "locale": "de",
                "name": "German",
                "enabled": false,
                "customerAdded": false,
                "createdAt": "2025-10-30T18:37:01.485Z",
                "updatedAt": "2025-10-30T18:37:01.485Z",
                "default": false
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/34d07233-16bd-45c9-8fb5-6a5bb7fddb82"
                    },
                    "status": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/34d07233-16bd-45c9-8fb5-6a5bb7fddb82/status"
                    }
                },
                "id": "34d07233-16bd-45c9-8fb5-6a5bb7fddb82",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "locale": "hu",
                "name": "Hungarian",
                "enabled": false,
                "customerAdded": false,
                "createdAt": "2025-10-30T18:37:01.496Z",
                "updatedAt": "2025-10-30T18:37:01.496Z",
                "default": false
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/eccfc200-851a-436f-8410-6f589cea2876"
                    },
                    "status": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/eccfc200-851a-436f-8410-6f589cea2876/status"
                    }
                },
                "id": "eccfc200-851a-436f-8410-6f589cea2876",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "locale": "it",
                "name": "Italian",
                "enabled": false,
                "customerAdded": false,
                "createdAt": "2025-10-30T18:37:01.493Z",
                "updatedAt": "2025-10-30T18:37:01.493Z",
                "default": false
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/e3a092fe-8945-461a-8690-05ec8243e79a"
                    },
                    "status": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/e3a092fe-8945-461a-8690-05ec8243e79a/status"
                    }
                },
                "id": "e3a092fe-8945-461a-8690-05ec8243e79a",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "locale": "ja",
                "name": "Japanese",
                "enabled": false,
                "customerAdded": false,
                "createdAt": "2025-10-30T18:37:01.506Z",
                "updatedAt": "2025-10-30T18:37:01.506Z",
                "default": false
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/92cc4bbe-77e8-41d5-902d-8a03d0658409"
                    },
                    "status": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/92cc4bbe-77e8-41d5-902d-8a03d0658409/status"
                    }
                },
                "id": "92cc4bbe-77e8-41d5-902d-8a03d0658409",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "locale": "ko",
                "name": "Korean",
                "enabled": false,
                "customerAdded": false,
                "createdAt": "2025-10-30T18:37:01.489Z",
                "updatedAt": "2025-10-30T18:37:01.489Z",
                "default": false
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/11e14e48-89fc-459b-9c6e-1a98cbfba6f9"
                    },
                    "status": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/11e14e48-89fc-459b-9c6e-1a98cbfba6f9/status"
                    }
                },
                "id": "11e14e48-89fc-459b-9c6e-1a98cbfba6f9",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "locale": "pl",
                "name": "Polish",
                "enabled": false,
                "customerAdded": false,
                "createdAt": "2025-10-30T18:37:01.507Z",
                "updatedAt": "2025-10-30T18:37:01.507Z",
                "default": false
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/f2f562c4-acde-4831-b9f1-9340aa4dde0d"
                    },
                    "status": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/f2f562c4-acde-4831-b9f1-9340aa4dde0d/status"
                    }
                },
                "id": "f2f562c4-acde-4831-b9f1-9340aa4dde0d",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "locale": "pt",
                "name": "Portuguese",
                "enabled": false,
                "customerAdded": false,
                "createdAt": "2025-10-30T18:37:01.490Z",
                "updatedAt": "2025-10-30T18:37:01.490Z",
                "default": false
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/0d205068-7aa0-43f4-a527-f2fa578598d0"
                    },
                    "status": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/0d205068-7aa0-43f4-a527-f2fa578598d0/status"
                    }
                },
                "id": "0d205068-7aa0-43f4-a527-f2fa578598d0",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "locale": "ru",
                "name": "Russian",
                "enabled": false,
                "customerAdded": false,
                "createdAt": "2025-10-30T18:37:01.487Z",
                "updatedAt": "2025-10-30T18:37:01.487Z",
                "default": false
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/af293eb7-1245-4d8e-b79d-e85cd9362613"
                    },
                    "status": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/af293eb7-1245-4d8e-b79d-e85cd9362613/status"
                    }
                },
                "id": "af293eb7-1245-4d8e-b79d-e85cd9362613",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "locale": "es",
                "name": "Spanish",
                "enabled": false,
                "customerAdded": false,
                "createdAt": "2025-10-30T18:37:01.498Z",
                "updatedAt": "2025-10-30T18:37:01.498Z",
                "default": false
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/b5e6ae16-c6c1-4c58-961d-6fd8f487f3d7"
                    },
                    "status": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/b5e6ae16-c6c1-4c58-961d-6fd8f487f3d7/status"
                    }
                },
                "id": "b5e6ae16-c6c1-4c58-961d-6fd8f487f3d7",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "locale": "th",
                "name": "Thai",
                "enabled": false,
                "customerAdded": false,
                "createdAt": "2025-10-30T18:37:01.504Z",
                "updatedAt": "2025-10-30T18:37:01.504Z",
                "default": false
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/eb8e19b3-1d91-4328-86b2-4bb1d4071831"
                    },
                    "status": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/eb8e19b3-1d91-4328-86b2-4bb1d4071831/status"
                    }
                },
                "id": "eb8e19b3-1d91-4328-86b2-4bb1d4071831",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "locale": "tr",
                "name": "Turkish",
                "enabled": false,
                "customerAdded": false,
                "createdAt": "2025-10-30T18:37:01.509Z",
                "updatedAt": "2025-10-30T18:37:01.509Z",
                "default": false
            }
        ]
    },
    "count": 17,
    "size": 17
}