Sign in
Test Environments

List all test environments

Use this operation to retrieves a list of all Test Environments. It returns an ArrayResponse containing TestEnvironmentResponse objects, representing the available Test Environments in the system.

User Access Permission

You must be assigned the Refresh Central Sandbox permission to run this operation.

get/test-environments

Headers

Zuora-Entity-Idsstring

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.

Zuora-Track-Idstring

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Accept-Encodingstring

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encodingstring

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Response

Successfully retrieved a list of Test Environment responses

sizeinteger

Example response

{
  "result": [
    {
      "createdById": "58f182ab203c447b8b9cd90382da030a",
      "environmentType": "ENTERPRISE",
      "id": "11111111-1111-1111-1111-111111111111",
      "status": "ACTIVE",
      "updatedById": "58f182ab203c447b8b9cd90382da030a"
    }
  ]
}

Changes