Retrieve organization default settings

Retrieve the default settings of an organization, including the device settings, event settings, and webhook destination URLs.

Request

Security:

bearerAuth

path Parameters

orgId

required

string

The ID of the organization. Obtain this from GET /organizations.

Example: 62

Responses

200

Successful operation

400

Bad request error

401

Unauthorized error

403

Forbidden error

404

Not found error

500

Internal server error

get/organizations/{orgId}/default-settings

Request samples

curl
JavaScript
Node.js

curl -i -X GET \
  https://api-prod.surfsight.net/v2/organizations/:orgId/default-settings \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Response samples

application/json

{"data": {"gpsWebhookUrl": "string",
"eventWebhookUrl": "string",
"eventWebhookConfig": "string",
"alarmsWebhookUrl": "string",
"alarmsWebhookConfig": "string",
"systemMessagesWebhook": "string",
"events": {"vehicleType": "Private",
"events": [{"eventType": "acceleration",
"dataType": "none",
"weight": 3,
"speedLimit": 120,
"config": {"headwayAlertDayThreshold": 2000,
"headwayAlertNightThreshold": 3000,
"headwayAlertTime": 3000
},
"laneWeavingTimes": 3,
"laneWeavingDurationSeconds": 30,
"drivingDuration": 8,
"visualAlert": true,
"audioAlert": true
}
]
},
"device": {"adas": {"value": true
},
"distractedDriver": {"value": true
},
"liveVideo": {"value": true
},
"driverCamera": {"value": true
},
"textOverlay": {"value": true
},
"inCabinCameraRecording": {"value": true
},
"driverPosition": {"value": "left"
},
"speedUnits": {"value": "mph"
},
"audioAlarms": {"value": true
},
"notifyLiveStreaming": {"value": true
},
"adminPin": {"value": "1234"
},
"driverPin": {"value": "4321"
},
"brightness": {"value": 128
},
"dateTimeUnits": {"value": "us"
},
"voiceRecording": {"value": true
},
"standby": {"timeout": 10
},
"hotSpot": {"internetAccess": true,
"hotspotEnabled": true
},
"recordingEncryption": {"enabled": true
},
"privacy": {"gpsEnabled": true,
"mvaiEnabled": true,
"liveStreamEnabled": true,
"allEventsEnabled": true,
"cameras": [{"cameraId": 1,
"recordingEnabled": true,
"eventsEnabled": true
}
]
},
"pinCodeDi": {"value": true
},
"qrDi": {"value": true
}
},
"isOrganizationProfileEnabled": true
},
"requestId": "06327cae-e075-42ca-b620-c5cfdd3b4e37"
}