API v1 Documentation
Client API > Response
Client API > Contacts
Client API > Display
Client API > Environment
Client API > User
Management API > Action Class
Management API > Attribute Class
Management API > Contact Attribute Keys
Management API > Contact Attributes
Management API > Contacts
Management API > Me
Management API > People
Management API > Response
Management API > Storage
Management API > Survey
Management API > Webhook
Health
Get Environment State
Retrieves the environment state to be used in Formbricks SDKs
GET
/
api
/
v1
/
client
/
{environmentId}
/
environment
curl --request GET \
--url http:///%7B{baseurl}%7D/api/v1/client/{environmentId}/environment
{
"data": {
"actionClasses": [
{
"id": "cm6orqtdd000b19wjec82bpp2",
"key": null,
"name": "New Session",
"noCodeConfig": null,
"type": "automatic"
},
{
"id": "cm6oryki3000i19wj860utcnn",
"key": "code",
"name": "code action",
"noCodeConfig": null,
"type": "code"
}
],
"project": {
"clickOutsideClose": true,
"darkOverlay": false,
"id": "cm6orqtcl000319wj9wb7dltl",
"inAppSurveyBranding": true,
"placement": "bottomRight",
"recontactDays": 7,
"styling": {
"allowStyleOverwrite": true,
"brandColor": {
"light": "#64748b"
}
}
},
"surveys": [
{
"autoClose": null,
"delay": 0,
"displayLimit": 5,
"displayOption": "respondMultiple",
"displayPercentage": null,
"endings": [
{
"buttonLabel": "Create your own Survey",
"buttonLink": "https://formbricks.com",
"headline": "Thank you!",
"id": "o729tod5klhix62njmk262dk",
"subheader": "We appreciate your feedback.",
"type": "endScreen"
}
],
"hiddenFields": {
"enabled": true,
"fieldIds": [
"<string>"
]
},
"id": "cm6orr901000g19wjwwa690eo",
"languages": [
"<string>"
],
"name": "Start from scratch",
"questions": [
{
"buttonLabel": "Next",
"charLimit": false,
"headline": "What would you like to know?",
"id": "dd5c8w2a4ttkbnjb9nwhtb17",
"inputType": "text",
"placeholder": "Type your answer here...",
"required": true,
"type": "openText"
}
],
"recontactDays": 0,
"segment": {
"createdAt": "2025-02-03T08:08:33.377Z",
"description": null,
"filters": [
"<string>"
],
"id": "cm6orr90h000h19wj1lnwoxwg",
"isPrivate": true,
"title": "cm6orr901000g19wjwwa690eo",
"updatedAt": "2025-02-03T08:08:33.377Z"
},
"showLanguageSwitch": null,
"status": "inProgress",
"styling": null,
"triggers": [
{
"actionClass": "code action"
}
],
"type": "app",
"variables": [
"<string>"
],
"welcomeCard": {
"buttonLabel": "Next",
"enabled": false,
"headline": "Welcome!",
"html": "Thanks for providing your feedback - let's go!",
"showResponseCount": false,
"timeToFinish": false
}
}
]
}
}
Path Parameters
The ID of the environment
Response
200
application/json
HTTP Status 200
Example:
[
{
"id": "cm6orqtdd000b19wjec82bpp2",
"key": null,
"name": "New Session",
"noCodeConfig": null,
"type": "automatic"
},
{
"id": "cm6oryki3000i19wj860utcnn",
"key": "code",
"name": "code action",
"noCodeConfig": null,
"type": "code"
}
]
Example:
true
Example:
false
Example:
"cm6orqtcl000319wj9wb7dltl"
Example:
true
Example:
"bottomRight"
Example:
7
List of surveys in the environment
Example:
null
Example:
0
Example:
5
Example:
"respondMultiple"
Example:
null
Example:
"Create your own Survey"
Example:
"https://formbricks.com"
Example:
"Thank you!"
Example:
"o729tod5klhix62njmk262dk"
Example:
"We appreciate your feedback."
Example:
"endScreen"
Example:
"cm6orr901000g19wjwwa690eo"
Example:
"Start from scratch"
Example:
"Next"
Example:
false
Example:
"What would you like to know?"
Example:
"dd5c8w2a4ttkbnjb9nwhtb17"
Example:
"text"
Example:
"Type your answer here..."
Example:
true
Example:
"openText"
Example:
0
Example:
"2025-02-03T08:08:33.377Z"
Example:
null
Example:
"cm6orr90h000h19wj1lnwoxwg"
Example:
true
Example:
"cm6orr901000g19wjwwa690eo"
Example:
"2025-02-03T08:08:33.377Z"
Example:
null
Example:
"inProgress"
Example:
null
Example:
"app"
Example:
"Next"
Example:
false
Example:
"Welcome!"
Example:
"Thanks for providing your feedback - let's go!"
Example:
false
Example:
false
Was this page helpful?
curl --request GET \
--url http:///%7B{baseurl}%7D/api/v1/client/{environmentId}/environment
{
"data": {
"actionClasses": [
{
"id": "cm6orqtdd000b19wjec82bpp2",
"key": null,
"name": "New Session",
"noCodeConfig": null,
"type": "automatic"
},
{
"id": "cm6oryki3000i19wj860utcnn",
"key": "code",
"name": "code action",
"noCodeConfig": null,
"type": "code"
}
],
"project": {
"clickOutsideClose": true,
"darkOverlay": false,
"id": "cm6orqtcl000319wj9wb7dltl",
"inAppSurveyBranding": true,
"placement": "bottomRight",
"recontactDays": 7,
"styling": {
"allowStyleOverwrite": true,
"brandColor": {
"light": "#64748b"
}
}
},
"surveys": [
{
"autoClose": null,
"delay": 0,
"displayLimit": 5,
"displayOption": "respondMultiple",
"displayPercentage": null,
"endings": [
{
"buttonLabel": "Create your own Survey",
"buttonLink": "https://formbricks.com",
"headline": "Thank you!",
"id": "o729tod5klhix62njmk262dk",
"subheader": "We appreciate your feedback.",
"type": "endScreen"
}
],
"hiddenFields": {
"enabled": true,
"fieldIds": [
"<string>"
]
},
"id": "cm6orr901000g19wjwwa690eo",
"languages": [
"<string>"
],
"name": "Start from scratch",
"questions": [
{
"buttonLabel": "Next",
"charLimit": false,
"headline": "What would you like to know?",
"id": "dd5c8w2a4ttkbnjb9nwhtb17",
"inputType": "text",
"placeholder": "Type your answer here...",
"required": true,
"type": "openText"
}
],
"recontactDays": 0,
"segment": {
"createdAt": "2025-02-03T08:08:33.377Z",
"description": null,
"filters": [
"<string>"
],
"id": "cm6orr90h000h19wj1lnwoxwg",
"isPrivate": true,
"title": "cm6orr901000g19wjwwa690eo",
"updatedAt": "2025-02-03T08:08:33.377Z"
},
"showLanguageSwitch": null,
"status": "inProgress",
"styling": null,
"triggers": [
{
"actionClass": "code action"
}
],
"type": "app",
"variables": [
"<string>"
],
"welcomeCard": {
"buttonLabel": "Next",
"enabled": false,
"headline": "Welcome!",
"html": "Thanks for providing your feedback - let's go!",
"showResponseCount": false,
"timeToFinish": false
}
}
]
}
}