GET
/
v1
/
environments
/
:id
curl https://api.zquenceeee.com/v1/environments/69f9b5fa0600ccbf9c677005 \
  -H "x-api-key: $ZQUENCE_PUBLIC_KEY" \
  -H "x-api-secret: $ZQUENCE_SECRET_KEY"
{
  "id": "69f9b5fa0600ccbf9c677005",
  "tenantId": "bc41c6ab-7206-4033-b632-4d1cfa86d840",
  "name": "Staging Sandbox",
  "type": "sandbox",
  "status": "active",
  "apiVersion": "v1",
  "webhookRetries": 3,
  "debugLogging": true,
  "rateLimitPerMinute": 120,
  "createdAt": "2026-02-04T11:30:00.000Z",
  "updatedAt": "2026-06-01T09:45:00.000Z"
}
Returns the full environment record for the given ID. Returns 404 if the environment does not exist or belongs to a different tenant.

Path parameters

id
string
required
The environment’s MongoDB ObjectId, as returned by List environments.

Returns

id
string
Environment ID (MongoDB ObjectId).
tenantId
string
Owning tenant identifier.
name
string
Human-readable display name (e.g. "Live", "Staging Sandbox").
type
string
Environment type — "live" or "sandbox".
status
string
"active" or "disabled". Disabled environments reject all incoming API requests.
apiVersion
string
API version configured for this environment. Currently always "v1".
webhookRetries
number
Number of webhook delivery retry attempts. Default 3.
debugLogging
boolean
When true, extended logs are captured for this environment. Default false.
rateLimitPerMinute
number | null
Per-minute API rate-limit override. null or absent means the tenant-level default applies.
createdAt
string
ISO 8601 UTC creation timestamp.
updatedAt
string
ISO 8601 UTC last-modified timestamp.

Error codes

StatusMeaning
400tenantId could not be resolved from the authenticated credential.
401Missing or invalid API key pair.
404No environment with this ID exists under the authenticated tenant.
curl https://api.zquenceeee.com/v1/environments/69f9b5fa0600ccbf9c677005 \
  -H "x-api-key: $ZQUENCE_PUBLIC_KEY" \
  -H "x-api-secret: $ZQUENCE_SECRET_KEY"
{
  "id": "69f9b5fa0600ccbf9c677005",
  "tenantId": "bc41c6ab-7206-4033-b632-4d1cfa86d840",
  "name": "Staging Sandbox",
  "type": "sandbox",
  "status": "active",
  "apiVersion": "v1",
  "webhookRetries": 3,
  "debugLogging": true,
  "rateLimitPerMinute": 120,
  "createdAt": "2026-02-04T11:30:00.000Z",
  "updatedAt": "2026-06-01T09:45:00.000Z"
}