Contact SalesFree Trial SIM

Account Settings

(AccountSettings endpoints are only accessible to scope org_super and org_managerplus.)

5 of 23

Filtering by query: /v1.0/accountSettings/deviceGroups

GET/v1.0/accountSettings/deviceGroupsRead-onlyPermalink ↗

Get list of child device groups, visible to current account.

Parameters

offsetquerynumberrequired

The number of device groups to skip before starting to collect the result set. Will be ignored if export param is specified.

limitquerynumberrequired

The number of device groups to return. Will be ignored if export param is specified.

sortquerystringrequired

Sort field

Values: DESCRIPTION, PARENTCORPID, CITY, STATE, ZIP, DAILY_LIMIT, MONTHLY_LIMIT

sortDirquerystringrequired

Sort direction

Values: ASC, DESC

searchValuequerystring

The filter that can be used to search on the following fields - Group Description, Parent Group, State/Province, Street, City, Zip/Postal Code.

exportquerystring

Export format type. Currently only CSV is accepted.

Values: CSV

columnsquerystring

Comma separated list of columns for CSV export. Values - DESCRIPTION, PARENT_CORP_DESCRIPTION, CITY, STATE, ZIP, MONTHLY_LIMIT, DAILY_LIMIT

cURL
curl -X GET "https://api.kajeet.dev/sentinel-proxy/sentinel/api/v1.0/accountSettings/deviceGroups?offset=0&limit=25&sort=LAST_30_DAYS_USED&sortDir=DESC&searchValue=Bus&export=CSV&columns=MDN%2CSTATUS%2CIMEI%2CLAST_30_DAYS_USED" \
  -H "Authorization: Bearer $SENTINEL_TOKEN"
POST/v1.0/accountSettings/deviceGroupsChanges dataPermalink ↗

Create a new device group

Parameters

modelbodyDeviceGroupPostModelrequired

model

logoImageformDatafile

image file to upload as device group logo.

cURL
curl -X POST "https://api.kajeet.dev/sentinel-proxy/sentinel/api/v1.0/accountSettings/deviceGroups" \
  -H "Authorization: Bearer $SENTINEL_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "example": true,
  "corpId": "NORTHSTAR-ISD"
}'
GET/v1.0/accountSettings/deviceGroups/filteredRead-onlyPermalink ↗

Get list of child device groups, visible to current account, filtered by feature access

Parameters

featurequerystringrequired

Feature name

Values: ACTIVATION, ACCOUNT_SETTINGS, DASHBOARD, DATABRIDGE_KEY_CREATE, DEVICES, FIRMWARE, GPS, GROUP_CHANGE_NOTIFICATION, INSIGHTS, INSIGHTS_DEVICE_USAGE, INSIGHTS_DEVICE_USAGE_GROUPS, INSIGHTS_CONTENT

valuequerystring

Value of feature flag. Default - Y

Values: Y, N

inheritedquerystring

Enables or disables inheritance logic. If set to N, inheritance logic is disabled and only direct values form DB are taken into account.

Values: Y, N

cURL
curl -X GET "https://api.kajeet.dev/sentinel-proxy/sentinel/api/v1.0/accountSettings/deviceGroups/filtered?feature=value&value=value&inherited=value" \
  -H "Authorization: Bearer $SENTINEL_TOKEN"
GET/v1.0/accountSettings/deviceGroups/hierarchyRead-onlyPermalink ↗

Get list of device groups under users group

Parameters

No parameters.

cURL
curl -X GET "https://api.kajeet.dev/sentinel-proxy/sentinel/api/v1.0/accountSettings/deviceGroups/hierarchy" \
  -H "Authorization: Bearer $SENTINEL_TOKEN"
PUT/v1.0/accountSettings/deviceGroups/{corpId}Changes dataPermalink ↗

Update a device group

Parameters

corpIdpathstringrequired

corpId

modelbodyDeviceGroupPutModelrequired

model

logoImageformDatafile

image file to upload as device group logo. Null - no change, blank - use default.

cURL
curl -X PUT "https://api.kajeet.dev/sentinel-proxy/sentinel/api/v1.0/accountSettings/deviceGroups/NORTHSTAR-ISD" \
  -H "Authorization: Bearer $SENTINEL_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "corpId": "NORTHSTAR-ISD",
  "note": "Example update payload — confirm schema in Swagger before wiring production."
}'

Build your first call in 5 minutes.

Grab a Dev SIM, get an API key, and POST /v1.0/auth/token from anywhere.

Free Trial SIMRead the Quickstart