Skip to content
Dashboard
Theme
Theme

Retrieve the environment

GET /v1/environment: Retrieve the environment.

View Markdown

GET /v1/environment

Scope
environment:read
Auth
Secret key (sk_…)
Since
1.0
  • OhAuthCat-Version string

    Minor version; defaults to the environment’s pin.

Errors share one shape; see the error code catalogue.

curl -X GET \
"https://api.ohauthcat.com/v1/environment" \
-H "Authorization: Bearer $OHAUTHCAT_API_KEY"
Response 200
{
"id": "env_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
"object": "environment",
"project": "proj_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
"name": "Acme Corp",
"type": "sandbox",
"consent_screen_default": "on",
"sign_in_failed_events": true,
"gusto_oauth_available": true,
"bamboohr_oauth_available": true,
"google_oauth_available": true,
"compat_workos_enabled": false,
"version_pin": "example_version_pin",
"home_region": "example_home_region",
"portal_success_urls": {},
"disabled_notices": [
"cert_expiry"
],
"portal_logo_url": "https://app.acme.com/callback",
"portal_embed_origins": [
"example_portal_embed_origin"
],
"support_email": "jane@acme.com",
"sign_ins_disabled": true,
"sign_ins_disabled_at": "2026-01-15T09:30:00Z",
"sign_ins_disabled_by": "customer",
"residency": {
"region": "eu",
"data_classes": [
{
"data_class": "example_data_class",
"description": "Primary SSO connection for Acme Corp.",
"scope": "home_region",
"region": "eu",
"personal_data": true
}
]
}
}