Skip to main content
GET
Get Environment

Authorizations

Authorization
string
header
required

API key as Bearer token. Use an account key (mfx_acct_...) for /account/* endpoints, and an environment key (mfx_test_... for sandbox, mfx_live_... for live) for /environment/*, /faxes, /webhooks, and /events.

Response

EnvironmentResource

id
string
required

Environment identifier (env_-prefixed).

Example:

"env_2BcD3eF4gH5iJ6kL7mN8oP"

name
string
required

Human-readable environment name.

type
enum<string>
required

Environment type.

Available options:
sandbox,
live
Example:

"sandbox"

status
enum<string>
required

Environment status. Currently always 'active'. Future environment-level suspension would introduce additional values; activation is reported via the account, not here.

Available options:
active
Example:

"active"

Last modified on May 11, 2026