ZENSIE API
The ZENSIE REST API is 30MHz's public platform API, documented in Swagger at https://api.30mhz.com/api/swagger and served from https://api.30mhz.com/api. It carries 558 operations across 425 paths covering sensors and sensor types, gateways and gateway clusters, checks (data sources), data query and data-upload/ingest, dashboards, widgets and charts, maps and zones, organizations, users, groups and notifications, cultivations and cultivation targets, apps (irrigation, GDD, RTR, CultiWatch), export partners, and the commercial surface (licenses, subscriptions, quotes, orders, invoices, pricing). Authentication is a bearer JWT API key issued from the ZENSIE Account Settings > Developer page and sent in the Authorization header.
This API exposes 558 operations across 425 paths, organized into 125 resource areas, and defines 300 schemas. It is described by OpenAPI 2.0, at version 2.0.
Requests are made against the base URL https://api.30mhz.com/api.
558 operations
425 paths
300 schemas
79 DELETE239 GET18 PATCH203 POST19 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
ZENSIE API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (Bearer).
Paths & Operations 558
Across 425 paths, the API surfaces 558 operations — 79 DELETE, 239 GET, 18 PATCH, 203 POST, 19 PUT. They span 125 resource areas, including admin, agent, assembly, assembly-update, authorization, billing-history-details, billing-history-details-update, billing-history, and 117 more. Each is listed below with its method, path, parameters, and response codes.
admin 6
GET
/admin/health/api-build-version
Returns the API build version.
GET
/admin/health/auth0
Returns the Auth0 health.
GET
/admin/health/dynamodb
Returns the DynamoDB health.
GET
/admin/health/elasticsearch
Returns the Elasticsearch health.
GET
/admin/health/scheduler
Returns the Scheduler health.
DELETE
/admin/notification-follow/user/{email}
Delete all notification follows of a user (i.e. Follow, NotificationFollow and NotificationTopicFollow objects).
agent 2
GET
/agent/conversation/{conversationId}/message
Return all messages of the provided conversation.
POST
/agent/message-stream
Send a message to the provided conversation and start a run.
assembly 6
POST
/assembly
Create a new assembly.
GET
/assembly/{serialNumber}
Get an assembly by its serial number.
DELETE
/assembly/{serialNumber}
Delete an assembly.
GET
/assembly/xbee/{xbee}
Get an assembly by its xbee.
GET
/assembly/{serialNumber}/history
Get the update history of an assembly as a map, where keys denote the date of change and values denote the changed assembly.
GET
/assembly/xbee/{xbee}/history
Get the update history of an assembly as a map, by its xbee, where keys denote the date of change and values denote the changed assembly.
assembly-update 1
POST
/assembly-update/{serialNumber}
Update an assembly.
authorization 19
GET
/authorization/device/jwks
Get public key for a device access token validation.
POST
/authorization/license/oauth/token
Provides an access token for a license service
POST
/authorization/role-assignment/assignee/{assignee}/role/{role}/license/{licenseId}
Assign a role on a license to a user, if the role already exists it will be a no-op
DELETE
/authorization/role-assignment/assignee/{assignee}/role/{role}/license/{licenseId}
Unassign a role on an license from a user.
POST
/authorization/role-assignment/assignee/{assignee}/role/{role}/organization/{organizationId}
Assign a role on an organization to a user, if the role already exists it will be a no-op
DELETE
/authorization/role-assignment/assignee/{assignee}/role/{role}/organization/{organizationId}
Unassign a role on an organization from a user.
POST
/authorization/role-assignment/assignee/{assignee}/role/{role}/device/{deviceId}
Assign a role on a device to a user, if the role already exists it will be a no-op
DELETE
/authorization/role-assignment/assignee/{assignee}/role/{role}/device/{deviceId}
Unassign a role on a device from a user.
POST
/authorization/role-assignment/assignee/{assignee}/role/{role}/organization/{organizationId}/site/{siteId}
Assign a role on a site to a user, if the role already exists it will be a no-op
DELETE
/authorization/role-assignment/assignee/{assignee}/role/{role}/organization/{organizationId}/site/{siteId}
Unassign a role on a site from a user.
GET
/authorization/check/device/{deviceId}
Check whether the user is authorized to perform a certain action on a device.
GET
/authorization/check/organization/{organizationId}
Check whether the user is authorized to perform a certain action on an organization.
GET
/authorization/check/organization/{organizationId}/site/{siteId}
Check whether the user is authorized to perform a certain action on a site.
GET
/authorization/device/{deviceId}/access-token
Get access token for a specific device.
GET
/authorization/role-assignment
Get all the role assignments of the current user
GET
/authorization/role-assignment/assignee/{assignee}/organization/{organizationId}
Get role assignments of a user on an organization.
GET
/authorization/role-assignment/assignee/{assignee}/license/{licenseId}
Get role assignments of a user under a license.
GET
/authorization/role-assignment/organization/{organizationId}
Get role assignments on an organization.
GET
/authorization/scopes
Get scopes for a specific user.
billing-history-details 4
GET
/billing-history-details/{billingHistoryDetailsId}
Return billing history detail
GET
/billing-history-details/organization/{organizationId}/year/{year}/month/{month}
Return billing history details
GET
/billing-history-details/organization/{organizationId}/year/{year}/month/{month}/json/{jsonCheck}
Return billing history details json / regular checks summary
GET
/billing-history-details/organization/{organizationId}/year/{year}/month/{month}/mother
Return billing history details mother summary
billing-history-details-update 2
POST
/billing-history-details-update/organization/{organizationId}/year/{year}/month/{month}/mother/{motherId}
Update a billing history details record for a given organization, mother, and a specific date
POST
/billing-history-details-update/{billingHistoryDetailsId}
Update a billing history details record for a given organization and a specific date
billing-history 8
GET
/billing-history/organization/{organizationId}/year/{year}/month/{month}
Return billing history
DELETE
/billing-history/organization/{organizationId}/year/{year}/month/{month}
Remove billing history for a specific organization and month, including the billing history details.
GET
/billing-history/organization/{organizationId}
Return billing history
POST
/billing-history/organization/{organizationId}/forecast
Return billing history forecast for current month
GET
/billing-history/all-organizations/year/{year}/month/{month}
Return billing history for a specific month for all organisations that are billable
GET
/billing-history/all-organizations
Return billing history for all organisations that are billable
POST
/billing-history/all-organizations
Generate billing history records for every billable organization for the past month (current - 1).
POST
/billing-history
Create billing history entry for an organization
billing-history-update 1
POST
/billing-history-update/organization/{organizationId}/year/{year}/month/{month}
Update a billing history record for a given organization and a specific date
chart 2
POST
/chart/scatterplot
Get a series data
POST
/chart/cultivation-target
Return the cultivation target setpoints with given date range and interval.
check 10
GET
/check/{checkId}
Returns the check with given check id
DELETE
/check/{checkId}
Removes the persisted check data, and the authorization information associated to this (followers and the notification settings).
GET
/check/sensor/default
Returns a sensor check with default values for most fields
POST
/check/organization/{organizationId}/clone/check/{checkId}
Clone a check in the organization given, based on another existing check
GET
/check/organization/{organizationId}
Return all the checks of the given organization
POST
/check/organization/{organizationId}
Create a new web check in the organization
GET
/check/gateway-cluster/{gatewayClusterId}
Return all the sensors of the given gateway cluster
GET
/check/gateway/{gatewayId}
Return all the sensors of the given gateway
POST
/check/delete-batch
Removes the persisted check data, and the authorization information associated to this (followers and the notification settings) for a set of check ids.
GET
/check/default
Returns a check with default values for most fields
check-update 5
POST
/check-update/{checkId}/new-organization/{newOrganizationId}
Transfer the check to another organization.
POST
/check-update/{checkId}/new-owner/{newOwner}
Transfer the check to another user
POST
/check-update/transfer
Transfers one or more checks to a target gateway
POST
/check-update/{checkId}
Update a check
POST
/check-update
Update a set checks
comment 13
GET
/comment/{commentId}
Get a comment
DELETE
/comment/{commentId}
Delete a comment
POST
/comment
Create a new comment.
POST
/comment/reply/{commentId}
Create a new reply.
GET
/comment/interval
Get comments by interval
GET
/comment/timeinterval
Get comments within an interval
GET
/comment/feed/group/{groupId}deprecated
Deprecated. Please use /paginated-feed/group/{groupId}.
GET
/comment/feed/organization/{organizationId}deprecated
Deprecated. Please use /paginated-feed/organization/{organizationId}.
POST
/comment/interval/{interval}
Get comments for interval
POST
/comment/from/{startDate}/until/{endDate}
Get comments within an interval
GET
/comment/paginated-feed/group/{groupId}
Get the paginated comments feed for a group
GET
/comment/paginated-feed/organization/{organizationId}
Get the paginated comments feed for an organization
POST
/comment/search
Search for comments
comment-update 2
POST
/comment-update/{commentId}
Update an existing comment.
POST
/comment-update/reply/{commentId}
Update an existing reply.
company-details 3
DELETE
/company-details/{companyDetailsId}
Delete company details with the given id.
GET
/company-details/organization/{organizationId}
Returns a list of company details linked to an organization
POST
/company-details/organization/{organizationId}
Create new company details.
company-details-update 1
POST
/company-details-update/{companyDetailsId}
Update company details
crop 7
GET
/crop
Return all crops.
POST
/crop
Create a new crop.
GET
/crop/{cropId}
Return the crop with the given id.
PUT
/crop/{cropId}
Update a crop.
DELETE
/crop/{cropId}
Delete a crop.
PATCH
/crop/{cropId}
Patch a crop.
GET
/crop/organization/{organizationId}
Returns crops available to the organization, i.e public crops and the organization's custom crops.
currency-rates 1
POST
/currency-rates
Add currency rates.
currency 3
GET
/currency
Get list of supported currencies.
POST
/currency
Create a new currency.
DELETE
/currency/{currencyId}
Remove currency.
customer-registration 3
GET
/registration/{registrationId}/activate
Activate a new pending registration.
DELETE
/registration/{registrationId}
Remove a customer registration.
POST
/registration
Create a new pending registration.
dashboard 8
GET
/dashboard/organization/{organizationId}
Return the dashboards of the organization given.
POST
/dashboard/organization/{organizationId}
Create a new dashboard in the organization given.
POST
/dashboard/clone/{dashboardId}/group/{groupId}
Copy an organization dashboard to a group. Sensors will be shared with group and dashboard will be cloned.
POST
/dashboard/organization/{organizationId}/diagnostics
Creates a dashboard for diagnostics purposes, showing the different existing sensors of the organization, their values, battery voltages, etc.
GET
/dashboard/group/{groupId}
Get dashboards in the group given.
POST
/dashboard/group/{groupId}
Create a new dashboard in the group given.
GET
/dashboard/{dashboardId}
Return a single dashboard with the given id.
DELETE
/dashboard/{dashboardId}
Delete the dashboard with given id.
dashboard-theme 8
POST
/dashboard-theme/{dashboardThemeId}/group/{groupId}
Assign a theme to an group.
DELETE
/dashboard-theme/{dashboardThemeId}/group/{groupId}
Remove a theme from an group.
POST
/dashboard-theme/{dashboardThemeId}/organization/{organizationId}
Assign a theme to an organization.
DELETE
/dashboard-theme/{dashboardThemeId}/organization/{organizationId}
Remove a theme from an organization.
POST
/dashboard-theme
Create a new dashboard theme.
GET
/dashboard-theme/{dashboardThemeId}
Get dashboard theme with the given id.
DELETE
/dashboard-theme/{dashboardThemeId}
Remove dashboard theme.
GET
/dashboard-theme/user/{email}
Get all dashboard themes of a user.
dashboard-theme-update 1
POST
/dashboard-theme-update/{dashboardThemeId}
Updates a dashboard theme.
dashboard-update 4
POST
/dashboard-update/organization/{organizationId}/dashboard/{dashboardId}
Apply an update to the given dashboard.
POST
/dashboard-update/organization/{organizationId}/dashboard/{dashboardId}/reorder
Re-order the widgets in the dashboard.
POST
/dashboard-update/group/{groupId}/dashboard/{dashboardId}/reorder
Re-order the widgets in the dashboard.
POST
/dashboard-update/group/{groupId}/dashboard/{dashboardId}
Apply an update to the given dashboard.
data-export 5
POST
/data-export
Data export
GET
/data-export/{dataExportId}/organization/{organizationId}
Get a data export entry from dynamodb
DELETE
/data-export/{dataExportId}/organization/{organizationId}
Delete a data export
GET
/data-export/organization/{organizationId}
Get data exports of the organization
POST
/data-export/count
Number of results the data export will return
data 1
POST
/data/sensors
Retrieves data for a given field of a set of sensors.
data-source-coordinates 6
POST
/data-source-coordinates
Create new data source coordinates.
GET
/data-source-coordinates/{dataSourceId}/timestamp/{timestamp}
Return the data source coordinates for a data source id and a UTC ISO 8601 timestamp
PUT
/data-source-coordinates/{dataSourceId}/timestamp/{timestamp}
Put data source coordinates for a data source id and a UTC ISO 8601 timestamp. (PUT not supported)
DELETE
/data-source-coordinates/{dataSourceId}/timestamp/{timestamp}
Delete data source coordinates at a given timestamp
PATCH
/data-source-coordinates/{dataSourceId}/timestamp/{timestamp}
Patch data source coordinates for a data source id and a UTC ISO 8601 timestamp.
GET
/data-source-coordinates/{dataSourceId}
Return all data source coordinates for a data source id.
data-source 1
PATCH
/data-source/bulk-edit
Bulk edit multiple data sources.
data-upload 4
GET
/data-upload/{dataUploadId}
Return the data upload with the given id.
DELETE
/data-upload/{dataUploadId}
Delete data upload
POST
/data-upload/organization/{organizationId}
Data upload
POST
/data-upload/group/{groupId}
Data upload
device 9
GET
/device/{deviceId}
Return the device with the given id.
PUT
/device/{deviceId}
Update a device.
DELETE
/device/{deviceId}
Delete a device.
PATCH
/device/{deviceId}
Patch a device.
GET
/device
Return all devices.
POST
/device
Create a new device.
GET
/device/organization/{organizationId}
Returns the devices associated with the given organization id.
GET
/device/organization/{organizationId}/site/{siteId}
Returns devices associated with the given site.
GET
/device/site/{siteUuid}
Returns devices associated with the given site.
export-partner-job 5
POST
/export-partner-job
Create new export partner job record
GET
/export-partner-job/{jobId}/organization/{organizationId}
Retrieves new export partner job record
DELETE
/export-partner-job/{jobId}/organization/{organizationId}
Removes new export partner job record
GET
/export-partner-job/organization/{organizationId}
Retrieves export partner jobs for the organization
POST
/export-partner-job/organization/{organizationId}
Retrieves jobs for the given organization, export partner, frequency, and active
export-partner-job-update 1
POST
/export-partner-job-update/{jobId}/organization/{organizationId}
Update export partner job
export-partner 4
GET
/export-partner/organization/{organizationId}
Retrieves export partners records for the organization
POST
/export-partner/organization/{organizationId}
Create new export partners record
GET
/export-partner/{exportPartnerId}/organization/{organizationId}
Retrieves new export partners record
DELETE
/export-partner/{exportPartnerId}/organization/{organizationId}
Removes new export partners record
export-partner-update 1
POST
/export-partner-update/{exportPartnerId}/organization/{organizationId}
Update export partner record
gateway-cluster 6
POST
/gateway-cluster/{gatewayClusterId}/migrate/{gatewayId}
Assigns all sensors in given gateway cluster to the given gateway.
POST
/gateway-cluster
Create a new gateway cluster.
GET
/gateway-cluster/{gatewayClusterId}
Return gateway cluster by id.
DELETE
/gateway-cluster/{gatewayClusterId}
Remove a Gateway Cluster
GET
/gateway-cluster/organization/{organizationId}
Return gateway clusters for the organization.
GET
/gateway-cluster/with-secrets/{gatewayClusterId}
Return gateway cluster with secrets by id.
gateway 4
POST
/gateway
Create a new gateway.
GET
/gateway/{gatewayId}
Return gateway.
DELETE
/gateway/{gatewayId}
Remove gateway.
GET
/gateway/status/{gatewayIds}
Return status of gateways.
gateway-update 1
POST
/gateway-update/{gatewayId}
Update a gateway.
util 3
POST
/util/contact
Sends a message to the ZENSIE staff
GET
/util/countries
Obtains the countries codes supported by ZENSIE
GET
/util/whitelist-ips
Obtains the whitelisted ranges of IPs needed by ZENSIE
group 8
GET
/group-member/group/{groupId}
List the members in a group
POST
/group-member/{email}/group/{groupId}
Add a user to a group
DELETE
/group-member/{email}/group/{groupId}
Remove a user from a group
POST
/group-member-update/{email}/group/{groupId}
Update a user in a group
POST
/group
Create a new group.
GET
/group/{groupId}
Get a group
DELETE
/group/{groupId}
Remove group.
GET
/group/member/{email}
View groups a user belongs too
group-update 1
POST
/group-update/{groupId}
Edit a group
health 1
GET
/health
Deep readiness probe reporting the health of all backing services.
highlight 7
GET
/highlight
Return all highlights.
POST
/highlight
Create a highlight.
GET
/highlight/{publishedAt}
Return the highlight with the given publication date.
PUT
/highlight/{publishedAt}
Patch a highlight (PUT not supported).
DELETE
/highlight/{publishedAt}
Delete a highlight.
PATCH
/highlight/{publishedAt}
Patch a highlight.
GET
/highlight/last
Return the last highlight.
import-check 15
DELETE
/import-check/date-entry/{dateEntryId}
Delete a date entry
GET
/import-check/{checkId}
Returns the import check with the specified check id.
DELETE
/import-check/{checkId}
Delete an import check.
DELETE
/import-check/{checkId}/collection/{collectionId}
Delete a collection from an import check
DELETE
/import-check/{checkId}/manual-input-data/{rowId}
Delete manual input data row.
GET
/import-check/organization/{organizationId}
Return all the import checks of the given organization
POST
/import-check/organization/{organizationId}
Create a new import check in the organization
GET
/import-check/{checkId}/date-entry
Get all date entries that belong to an import check
POST
/import-check/{checkId}/date-entry
Create a new date entry that belongs to an import check
GET
/import-check/{checkId}/collection/{collectionId}/stats
Get values for a given collection in a check.
GET
/import-check/date-entry/{dateEntryId}/stats
Get values for a date entry
GET
/import-check/{check-id}/manual-input-data
Get data for a manual input check
POST
/import-check/{checkId}/date-entries
Add new date entries to an import check
POST
/import-check/{checkId}/collection
Add collections to an import check
POST
/import-check/copy/{checkId}/organization/{destinationOrganizationId}
Copy an external sensor into the organization. The new sensor properties can be overridden with 'sensorOverrides'. If 'sensorTypeOverrides' is null, the sensor type will be shared with the org, other…
import-check-update 4
POST
/import-check-update/{checkId}/collection/{collectionId}
Update a collection
POST
/import-check-update/{checkId}/collection/reorder
Reorder the collection order
POST
/import-check-update/date-entry/{dateEntryId}
Update a date entry
POST
/import-check-update/{checkId}
Update an import check
ingest 5
POST
/ingest/manual-input-delete
Delete manual import check data based on keys
GET
/ingest/organization/{organizationId}/import-check/{importCheckId}/example-call
Import check event template.
POST
/ingest/organization/{organizationId}
Ingest external sensor data.Supports multiple events (100 max) except for manual input event creation.
POST
/ingest/manual-input-update
Update manual data.
POST
/ingest/manual-input-update/{id}
Update manual data by event id.
ingest-update 1
POST
/ingest-update/import-check/{importCheckId}/timestamp/{timestamp}
Update ingested external sensor data.
integration 2
POST
/integration/activate/{integrationId}
POST
/integration/deactivate/{integrationId}/installation/{installationId}
integrity-check 3
GET
/integrity-check/unique-mother-assignment
The mothers in the mothers table are referenced in ONE (not less, not more) location of the locations table.
GET
/integrity-check/location-mothers-exist
The mother ids mentioned in the locations table exist in the mothers table.
GET
/integrity-check/sensor-location-mother
Checks if a location has sensor checks but no mother assigned to it.
license 9
POST
/license/{licenseId}/{organizationId}
Assign a license to an existing organization.
DELETE
/license/{licenseId}/{organizationId}
Remove license from an organization.
GET
/license/{licenseId}
Return the license with the given id.
PUT
/license/{licenseId}
Update a license.
DELETE
/license/{licenseId}
Delete a license.
PATCH
/license/{licenseId}
Patch a license.
GET
/license
Return all licenses.
POST
/license
Create a new license.
GET
/license/{licenseId}/organizations
Return the list of organizations with the given license.
location 6
GET
/location/{locationName}deprecated
Return the location with the given location name.
DELETE
/location/{locationName}deprecated
Removes the location, the queue associated to it, and IAM user.
POST
/locationdeprecated
Create a new location.
GET
/location/privatedeprecated
Returns all the available private locations in the system.
GET
/location/organization/{organizationId}deprecated
Returns all the available private locations for that organization.
GET
/location/publicdeprecated
Returns all the public locations
location-update 2
POST
/location-update/organization/{organizationId}/location/{locationId}deprecated
Update a site
POST
/location-update/{locationName}deprecated
Update a location
map 2
PUT
/map
Bulk edit zones and data source coordinates on the map for a site within an organization.
PATCH
/map
Bulk edit zones and data source coordinates on the map for a site within an organization.
metric 5
GET
/metric/{metricId}
Returns the metric with the specified type id.
DELETE
/metric/{metricId}
Remove metric.
GET
/metric
Returns all the metrics.
POST
/metric
Creates new metric.
GET
/metric/conversions
Returns the metrics that have possible conversions.
metric-update 1
POST
/metric-update/{metricId}
Update a metric
mother 8
GET
/mother
Returns all the mothers.
POST
/mother
Add a new mother.
GET
/mother/{motherId}/organization/{organizationId}/admin
Returns the mother with the specified id - containing extra details.
GET
/mother/{motherId}/organization/{organizationId}
Returns the mother with the specified id.
GET
/mother/{motherId}/json
Returns the json variable for the mother.
GET
/mother/{motherId}/organization/{organizationId}/status
Returns the status for mother with the specified id.
GET
/mother/organization/{organizationId}
Returns the mothers for the given organization
DELETE
/mother/{motherId}
Remove mother.
mother-template 4
GET
/mother-template
Returns all the mother templates.
POST
/mother-template
Add a new mother template.
GET
/mother-template/{templateId}
Returns the mother template with the specified id.
DELETE
/mother-template/{templateId}
Remove mother template.
mother-template-update 1
POST
/mother-template-update/{templateId}
Updates a mother template
mother-update 1
POST
/mother-update/{motherId}
Updates a mother
news 1
GET
/news
Return last news articles.
notes 6
POST
/notes
Create a note.
GET
/notes/{noteId}
Return the note with the given id.
PUT
/notes/{noteId}
Patch a note (PUT not supported).
DELETE
/notes/{noteId}
Delete a note.
PATCH
/notes/{noteId}
Patch a note.
GET
/notes/cultivation/{cultivationId}
Return the notes of the cultivation.
notification-follow 5
POST
/notification-follow/{notificationId}/user/{email}
Adds a follow to a notification.
DELETE
/notification-follow/{notificationId}/user/{email}
Delete a notification follow with the given id.
GET
/notification-follow/organization/{organizationId}/user/{email}
Retrieves all notification follows for a user within an organization.
POST
/notification-follow/organization/{organizationId}/count
Retrieves the followers counts of notifications
GET
/notification-follow/{notificationId}
Retrieves all followers of a notification
notification-follow-update 1
POST
/notification-follow-update/{notificationId}/user/{email}
Update an existing notification.
notification 8
POST
/notification
Create a new notification.
GET
/notification/{notificationId}
Retrieve a notification with the given id.
PUT
/notification/{notificationId}
Update a notification.
DELETE
/notification/{notificationId}
Delete the notification with the given id.
PATCH
/notification/{notificationId}
Patch a notification.
GET
/notification/organization/{organizationId}
Return the notifications of the organization given.
POST
/notification/organization/{organizationId}deprecated
Create a new notification in the organization given.
GET
/notification/check/{checkId}
Retrieve all notifications for a check.
notification-settings 4
POST
/notification-settings/check/{checkId}/user/{email}
Adds a notification setting to a check.
DELETE
/notification-settings/check/{checkId}/user/{email}
Removes the given notification setting from the check.
GET
/notification-settings/check/{checkId}
Returns the notification settings associated with the check.
GET
/notification-settings/organization/{organizationId}/user/{email}
Return all the checks of the given organization and the notifications associated with the user
notification-settings-update 1
POST
/notification-settings-update/check/{checkId}/user/{email}
Update a notification setting
notification-topic-follow 5
POST
/notification-topic-follow/{notificationTopicId}/user/{email}/organization/{organizationId}
Adds a follow to a notification topic.
DELETE
/notification-topic-follow/{notificationTopicId}/user/{email}/organization/{organizationId}
Delete a notification topic follow with the given id, email and organization id.
GET
/notification-topic-follow/organization/{organizationId}/user/{email}
Retrieves all notification topic follows for a user within an organization.
POST
/notification-topic-follow/organization/{organizationId}/count
Retrieves the followers counts of notification topics
GET
/notification-topic-follow/{notificationTopicId}/organization/{organizationId}
Retrieves all followers of a notification topic within an organization
notification-topic-follow-update 1
POST
/notification-topic-follow-update/{notificationTopicId}/user/{email}/organization/{organizationId}
Update an existing notification topic follow.
notification-topic 4
GET
/notification-topic
Return all the notifications topics.
POST
/notification-topic
Create a new notification topic
GET
/notification-topic/{notificationTopicId}
Retrieve a notification topic with the given id.
DELETE
/notification-topic/{notificationTopicId}
Delete a notification topic with the given id.
notification-topic-update 1
POST
/notification-topic-update/{notificationTopicId}
Update a notification in the notification id.
notification-update 1
POST
/notification-update/{notificationId}deprecated
Update a notification in the notification id.
offer 4
PUT
/offer/{offerId}
Update an offer.
DELETE
/offer/{offerId}
Delete an offer.
PATCH
/offer/{offerId}
Patch an offer.
POST
/offer
Create a new offer.
organization 20
GET
/organization/{organizationId}
Returns the organization.
DELETE
/organization/{organizationId}
Remove organization.
GET
/organization
Returns all organizations.
POST
/organization
Create a new organization.
GET
/organization/{organizationId}/site/{siteId}
Return the site.
PATCH
/organization/{organizationId}/site/{siteId}
Update a site
POST
/organization/{organizationId}/location/{locationId}/activatedeprecated
Updates if necessary and then activates a site
POST
/organization/{organizationId}/site/{siteId}/activate
Updates if necessary and then activates a site
POST
/organization/{organizationId}/user/{email}
Add a user to an organization.
PUT
/organization/{organizationId}/user/{email}
Modify user organization membership.
DELETE
/organization/{organizationId}/user/{email}
Remove user organization membership.
POST
/organization/{organizationId}/location/{locationId}/deactivatedeprecated
Deactivates a site.
POST
/organization/{organizationId}/site/{siteId}/deactivate
Deactivates a site.
DELETE
/organization/{organizationId}/location/{locationId}
Delete site.
GET
/organization/user/{notUsed}deprecated
Returns all the organizations that the user belongs to.
GET
/organization/user/email/{email}
Returns all the organizations that the user with the given email belongs to.
GET
/organization/user
Returns all the organizations that the user belongs to.
GET
/organization/billable
Returns all billable organizations.
POST
/organization/{organizationId}/locationdeprecated
Request a new site.
POST
/organization/{organizationId}/site
Request a new site.
organization-update 2
POST
/organization-update/{organizationId}
Update an organization
POST
/organization-update/{organizationId}/user/{email}deprecated
Modify user organization membership.
partner 3
POST
/partner
Create a new partner.
PUT
/partner/{partnerId}
Update a partner.
DELETE
/partner/{partnerId}
Remove a partner.
pricing 4
POST
/pricing/default/{currencyId}
Pricing
POST
/pricing
Pricing
GET
/pricing/organization/{organizationId}
Return pricing for organization
GET
/pricing/organization/{organizationId}/year/{year}/month/{month}
Return pricing for organization for the given year and month. Prior to September 2018 pricing for all organizations was in EUR.
pricing-update 1
POST
/pricing-update/organization/{organizationId}
Update a pricing record for an organization
product 4
GET
/product
Gets all the products.
POST
/product
Create a new product.
GET
/product/{productId}
Gets the product with the specified id.
DELETE
/product/{productId}
Remove product.
product-update 1
POST
/product-update/{productId}
Update a product with a given product id
sensor 3
POST
/sensor/{sensorId}
Create a sensor check
POST
/sensor/organization/{organizationId}/location/{locationName}/{sensorId}deprecated
Create a sensor check
GET
/sensor/{checkId}/voltage
Return the current voltage level of the sensor or null if not available.
sensor-type 11
GET
/sensor-type/{sensorTypeId}
Returns the sensor type with the specified type id.
POST
/sensor-type/{sensorTypeId}
Creates new sensor types.
DELETE
/sensor-type/{sensorTypeId}
Remove sensor type.
GET
/sensor-type/external/organization/{organizationId}
Returns all the external sensor types for the given organization.
GET
/sensor-type/organization/{organizationId}/location/{locationName}
Returns all the sensor types for the given organization and location.
GET
/sensor-type/organization/{organizationId}
Returns all the private sensor types of an organization.
POST
/sensor-type/organization/{organizationId}
Creates new private sensor type.
GET
/sensor-type
Returns all the public sensor types.
GET
/sensor-type/all
Get all sensor types (public and private).
GET
/sensor-type/user/{email}
Returns all the sensor types a user has access to.
GET
/sensor-type/external/{sensorTypeId}
External sensor data template.
sensor-type-update 1
POST
/sensor-type-update/{sensorTypeId}
Update a sensor type setting
shared-check 9
POST
/shared-check
Share one or more checks with one or more users or with a group
GET
/shared-check/{sharedCheckId}
Gets a specific shared check
DELETE
/shared-check/{sharedCheckId}
Deletes a specific shared check
GET
/shared-check/from/organization/{organizationId}
Returns all the checks for the given organization that have been shared
GET
/shared-check/by/{by}
Returns all the checks shared by the given user
GET
/shared-check/with/{with}
Returns all the checks shared with the requested user by the current user
GET
/shared-check/check/{checkId}
Returns the details (shared by who, shared with who etc) of a check that has been shared.
DELETE
/shared-check/check/{checkId}
Turn sharing off for a check
GET
/shared-check/with-group/{groupId}
Get the sensors belonging a group
shared-dashboard 8
POST
/shared-dashboard
Share one or more dashboards with one or more users
GET
/shared-dashboard/{sharedDashboardId}
Gets a specific shared dashboard
DELETE
/shared-dashboard/{sharedDashboardId}
Deletes a specific shared dashboard
GET
/shared-dashboard/from/organization/{organizationId}
Returns all the dashboards for the given organization that have been shared
GET
/shared-dashboard/by/{by}
Returns all the dashboards shared by the given user
GET
/shared-dashboard/with/{with}
Returns all the dashboards shared with the requested user by the current user
GET
/shared-dashboard/dashboard/{dashboardId}
Returns the details (shared by who, shared with who etc) of a dashboard that has been shared.
DELETE
/shared-dashboard/dashboard/{dashboardId}
Turn sharing off for a dashboard
shared-dashboard-update 1
POST
/shared-dashboard-update/{sharedDashboardId}
Apply an update to the given dashboard.
share-sensor-type 9
GET
/share-sensor-type/shared-by/organization/{organizationId}
Returns all sensor types shared by an organization.
GET
/share-sensor-type/{sensorTypeId}/shared-with
Get shared information about the sensor type.
POST
/share-sensor-type/sensor-type/{sensorTypeId}/group/{groupId}
Share a sensor type with a group.
POST
/share-sensor-type/sensor-type/{sensorTypeId}/organization/{organizationId}
Share a sensor type with an organization.
POST
/share-sensor-type/sensor-type/{sensorTypeId}/user/{email}
Share a sensor type with a user.
GET
/share-sensor-type/group/{groupId}
Get shared sensor types with a group.
GET
/share-sensor-type/organization/{organizationId}
Get shared sensor types with an organization.
GET
/share-sensor-type/user/{email}
Get shared sensor types shared with a user.
DELETE
/share-sensor-type/{sharedSensorTypeId}
Unshare a sensor type.
site 3
GET
/site
Return all permitted sites for the user.
GET
/site/organization/{organizationId}/site/{siteId}/data-sources
Return data sources in site.
GET
/site/{siteUuid}
Return site with the given uuid.
soil 7
GET
/soil
Return all soils.
POST
/soil
Create a new soil.
GET
/soil/{soilId}
Return the soil with the given id.
PUT
/soil/{soilId}
Update a soil.
DELETE
/soil/{soilId}
Delete a soil.
PATCH
/soil/{soilId}
Patch a soil.
GET
/soil/organization/{organizationId}
Return soils available to the organization.
subscription-assignment 4
GET
/subscription-assignment
Return all subscription assignments.
POST
/subscription-assignment
Create a new subscription assignment.
DELETE
/subscription-assignment/license/{licenseId}/subscription/{subscriptionId}/organization/{organizationId}
Delete a subscription assignment.
GET
/subscription-assignment/organization/{organizationId}
Return the subscription assignment in the given organization.
subscription 7
GET
/subscription
Return all subscriptions.
POST
/subscription
Create a new subscription.
GET
/subscription/{subscriptionId}/license/{licenseId}
Return the subscription with the given id.
PUT
/subscription/{subscriptionId}/license/{licenseId}
Update a subscription.
DELETE
/subscription/{subscriptionId}/license/{licenseId}
Delete a subscription.
PATCH
/subscription/{subscriptionId}/license/{licenseId}
Update the subscription with the given id.
GET
/subscription/license/{licenseId}
Returns the subscriptions associated with the given license id.
swagger 4
GET
/swagger/integrate.json
Get the integrate JSON
GET
/swagger/integrate
Get the integrate swagger definition
GET
/swagger/robocrops
Get the robocrops swagger definition
GET
/swagger/robocrops.json
Get the robocrops JSON
timezone 1
GET
/timezone
Get the supported timezones
userconfig 6
GET
/user/{email}/config
Return all configs for a user.
POST
/user/{email}/config
Create a new config for a user.
GET
/user/{email}/config/{configKey}
Return a config for a user.
PUT
/user/{email}/config/{configKey}
Update a config for a user.
DELETE
/user/{email}/config/{configKey}
Delete a config for a user.
PATCH
/user/{email}/config/{configKey}
Patch a config for user.
user 19
GET
/user
Returns the stored information associated to the current user
POST
/user/sign-up
Sign up.
POST
/user/change-password/{email}/{authorizationCode}
Confirms the user's password change
GET
/user/all
Returns all the system users. Operation reserved to system admins.
POST
/user/register/user/{email}
Registers a new guest user that does not belong to any organization. Authorization code should be included.
POST
/user/activate/user/{email}deprecated
Activates a new user that was added as member of an organization.Authorization code should be included.
GET
/user/account-managers
Returns all the account managers.
GET
/user/organization-member/organization/{organizationId}
Returns the organization memberships that belong to an organization.
GET
/user/organization/{organizationId}
Returns the users that belong to an organization.
GET
/user/{email}
Returns the requested User
DELETE
/user/{email}
Removes the user, along with all her notification settings of checks (follows). WARNING: Cannot be undone.
GET
/user/has-api-key
Checks if user has an api key
POST
/user/invite/organization/{organizationId}/role/{role}
Invites valid users to join Zensie
POST
/user/invite
Invites a user to an organization
POST
/user/api-key/request
Requests an API key for the authenticated user. If user already had an API key, it is replaced by the new one.
POST
/user/api-key/request-with-password
Requests an API key for a user with valid username and password. If user already had an API key, it is replaced by the new one. It is effectively the same as the api-key/request endpoint, the differe…
GET
/user/change-password/{email}
Request to make a password change for the user with given email
DELETE
/user/api-key
Revokes the current API key for the authenticated user
DELETE
/user/{email}/api-key
Revokes the current API key for the user with the given email address
user-update 3
POST
/user-update/{email}
Update an user
POST
/user-update/{email}/favoritePage
Add a favorite page to a user
DELETE
/user-update/{email}/favoritePage
Remove a favorite page for a user
widget 6
GET
/widget/dashboard/{dashboardId}
Return all the widgets of the given dashboard.
POST
/widget/dashboard/{dashboardId}
Create one or more widgets in the dashboard given.
GET
/widget/{widgetId}
Retrieve a widget
DELETE
/widget/{widgetId}
Delete a widget from its dashboard.
POST
/widget/clone/{widgetId}
Clones the widget to an optional target dashboard. If target dashboard is not set, the widget is duplicated in its own dashboard.
POST
/widget/organization/{organizationId}
Create one or more widgets in the given organization.
widget-update 1
POST
/widget-update/{widgetId}
Updates the widget.
zone 4
PUT
/zone/organization/{organizationId}/site/{siteId}/zone/{zoneId}
Patch a zone (PUT not supported).
DELETE
/zone/organization/{organizationId}/site/{siteId}/zone/{zoneId}
Delete a zone.
PATCH
/zone/organization/{organizationId}/site/{siteId}/zone/{zoneId}
Patch a zone.
POST
/zone/organization/{organizationId}/site/{siteId}
Create a new zone.
app-installation 13
POST
/app-installation/{installationId}/activate
Activate app installation
POST
/app-installation/{installationId}/deactivate
Deactivate app installation
PUT
/app-installation/{installationId}/configuration/{configKey}
Put a dynamic configuration.
DELETE
/app-installation/{installationId}/configuration/{configKey}
Delete a dynamic configuration.
PATCH
/app-installation/{installationId}/configuration/{configKey}
Patch a dynamic configuration, or creates it if does not exist.
GET
/app-installation/{installationId}
Return app installation
DELETE
/app-installation/{installationId}
Uninstall a ZENSIE application.
GET
/app-installation/{installationId}/configuration
Return installation's active configuration.
GET
/app-installation/{installationId}/configuration/{date}
Return installation's configuration for a specific date.
GET
/app-installation/{installationId}/configuration/prefix/{prefix}
Returns app configurations with a given prefix.
GET
/app-installation/organization/{organizationId}
Return app installations for the organization.
GET
/app-installation/app/{appId}
Return all active app installations with the given appId.
POST
/app-installation/organization/{organizationId}/location/{locationId}/app/{appId}
Install a ZENSIE application.
app-installation-update 1
POST
/app-installation-update/{installationId}
Update an application installation.
app 9
GET
/app/{appId}
Return the app with the given id.
DELETE
/app/{appId}
Delete an application.
GET
/app
Return all published extensions.
POST
/app
Create a new application.
GET
/app/all
Return all extensions.
GET
/app/installable
Return installable extensions.
POST
/app/{appId}/publish
Publish an application.
POST
/app/{appId}/submit
Submit an application.
POST
/app/{appId}/logo
Upload a logo for an application.
app-update 3
POST
/app-update/{appId}/logo
Update a logo for an extension.
PUT
/app-update/{appId}/properties
Patch an application's properties.
POST
/app-update/{installableId}
Update an installable.
calculation 4
GET
/calculation/{calculationId}
Get a calculation
POST
/calculation/{calculationId}
Perform calculation.
DELETE
/calculation/{calculationId}
Remove calculation.
POST
/calculation
Create a new calculation.
calculation-update 1
POST
/calculation-update/{calculationId}
Update a calculation.
app-cultiwatch 2
POST
/app/cultiwatch/drop
Returns the drop calculation.
POST
/app/cultiwatch/drop/interval/{interval}
Returns multiple drop calculation by interval.
app-irrigation 1
POST
/app/irrigation/trigger-sensor-aggregation
Trigger an aggregation of irrigation management sensors
customer-request-item 3
GET
/customer-request-item/{customerRequestItemId}
Returns the customer request item with the specified id.
DELETE
/customer-request-item/{customerRequestItemId}
Remove customer request item.
POST
/customer-request-item
Add a new customer request items.
customer-request-item-update 1
POST
/customer-request-item-update
Updates customer request items
customer-request 4
POST
/customer-request
Add a customer request.
GET
/customer-request/{customerRequestId}
Returns the customer request with the specified id.
DELETE
/customer-request/{customerRequestId}
Remove a customer request id.
GET
/customer-request/organization/{organizationId}
Returns the customer requests for the given organization
customer-request-update 1
POST
/customer-request-update/{customerRequestId}
Updates a customer request
dealer 4
GET
/dealer
Returns all dealers.
POST
/dealer
Add a dealer.
GET
/dealer/{email}
Returns a dealer by email.
DELETE
/dealer/{email}
Delete a dealer.
dealer-update 1
POST
/dealer-update/{email}
Update a dealer.
invoice 5
GET
/invoice
Returns all the invoices.
POST
/invoice
Add an invoice.
GET
/invoice/{invoiceId}
Returns the invoice with the specified id.
DELETE
/invoice/{invoiceId}
Deletes the invoice with the specified id.
GET
/invoice/customer-request/{customerRequestId}
Returns the invoice with the specified customer request id.
invoice-update 1
POST
/invoice-update/{invoiceId}
Updates a invoice
order 6
POST
/order/{orderId}/invoice
Creates an invoice from an order.
GET
/order
Returns all the orders.
POST
/order
Add an order.
GET
/order/{orderId}
Returns the order with the specified id.
DELETE
/order/{orderId}
Deletes the order with the specified id.
GET
/order/customer-request/{customerRequestId}
Returns the order with the specified customer request id.
order-update 1
POST
/order-update/{orderId}
Updates a order
quote 5
GET
/quote
Returns all the quotes.
POST
/quote
Add a quote.
POST
/quote/{quoteId}/order
Creates an order from a quote.
GET
/quote/{quoteId}
Returns the quote with the specified id.
DELETE
/quote/{quoteId}
Deletes the quote with the specified id.
quote-update 1
POST
/quote-update/{quoteId}
Updates a quote
cultivation 8
GET
/cultivation
Return all cultivations.
POST
/cultivation
Create a cultivation.
GET
/cultivation/organization/{organizationId}/cultivation/{cultivationId}
Return the cultivation with the given id.
PUT
/cultivation/organization/{organizationId}/cultivation/{cultivationId}
Patch a cultivation (PUT not supported).
DELETE
/cultivation/organization/{organizationId}/cultivation/{cultivationId}
Delete a cultivation.
PATCH
/cultivation/organization/{organizationId}/cultivation/{cultivationId}
Patch a cultivation.
GET
/cultivation/organization/{organizationId}
Return cultivations of the organization.
POST
/cultivation/organization/{organizationId}/cultivation/{cultivationId}/passport-image
Upload a file for a cultivation
cultivation-target 7
GET
/cultivation-target/organization/{organizationId}/cultivation/{cultivationId}
Return the targets for a cultivation.
GET
/cultivation-target/organization/{organizationId}/cultivation/{cultivationId}/target/{cultivationTargetId}
Return the cultivation target with the given id.
PUT
/cultivation-target/organization/{organizationId}/cultivation/{cultivationId}/target/{cultivationTargetId}
Patch a cultivation target (PUT not supported).
DELETE
/cultivation-target/organization/{organizationId}/cultivation/{cultivationId}/target/{cultivationTargetId}
Delete a cultivation target.
PATCH
/cultivation-target/organization/{organizationId}/cultivation/{cultivationId}/target/{cultivationTargetId}
Patch a cultivation target.
GET
/cultivation-target
Return all cultivation targets.
POST
/cultivation-target
Create a cultivation target.
downtime 3
GET
/downtime/{checkId}/interval/{interval}
Returns the date histogram aggregations recorded downtimes of the check at the request interval
GET
/downtime/{checkId}/{period}
FOR BACKWARD COMPATIBILITY ONLY: Returns the date histogram aggregations recorded downtimes of the check at the request period interval
GET
/downtime/{checkId}/from/{startDate}/until/{endDate}
Returns the date histogram aggregations related to the recorded downtimes of the sensor at the requested from/until period interval
stats 11
POST
/stats/aggregate
Returns aggregated data (averaged, max, min) over an interval of time for a set of sensors.
GET
/stats/condition/{checkId}
Returns if the check's last recorded stat meets the condition
GET
/stats/events/check/{checkId}/interval/{interval}
Returns event count for the sensor or web check with given check id, for the time range indicated.
GET
/stats/events/check/{checkId}/from/{startDate}/until/{endDate}
Returns event count for the sensor or web check with given check id, for the time range indicated.
GET
/stats/check/{checkId}
Returns the last value recorded of the check
GET
/stats/check/{checkId}/interval/{interval}
Returns historical data for the sensor or web check with given check id, for the interval indicated.
GET
/stats/check/{checkId}/from/{startDate}/until/{endDate}
Returns historical data for the sensor or web check with given check id, for the time range indicated.
POST
/stats
Returns the information about the more recent value for one or more sensors.
POST
/stats/checks/interval/{interval}
Returns historical data for the checks and the interval indicated.
POST
/stats/from/{startDate}/until/{endDate}
Returns historical data for the sensors or web checks with given check ids, for the time range indicated.
GET
/stats/network/organization/{organizationId}
Gets the Network (web checks, sensor checks, routers, and mothers) status overview for the given organization.
uptime 3
POST
/uptime/checks/from/{startDate}/until/{endDate}
Return the uptime of sensors within the given datetime range
GET
/uptime/check/{checkId}/interval/{interval}
Return the uptime of a sensor within the given interval
POST
/uptime/checks/interval/{interval}
Return the uptime of sensors within the given interval
status 12
GET
/status/backup-healthcheck
Lookup in S3 if backups are being made.
GET
/status/ingest
Retrieves status information of ingest checks for an organization
GET
/status/compareReadChecksOperations
Compare the database check read operations to verify that there was not a huge variation.
GET
/status/compareWriteChecksOperations
Compare the database check write operations to verify that there was not a huge variation.
GET
/status/cloudwatch-alarm/{alarmName}
Retrieves specific cloud watch alarm
GET
/status/cloudwatch-alarm
Retrieves cloud watch alarms that have status ALARM
GET
/status/compareThroughput
Compare the current throughput from a location, user or global in the system to verify that it's as expected.
POST
/status/alarm/throughput/location/{locationName}
Create throughput alarms for the given location.
POST
/status/alarm/mother/location/{locationName}/device/{deviceId}
Creates alarm (web check) for the mother of the location. Returns the check id created.
POST
/status/alarm/throughput/organization/{organization}
Create throughput alarms for the given organization.
GET
/status/elasticsearch/nodesstats/{nodesStatsName}/statsName/{statsName}
Retrieves node stats for elasticsearch cluster with the specified stats name. The possible parameters are listed here , for example nodesStatsName='os', statsName='loadaverage'
GET
/status/mothers/organization/{organizationId}
Checks if all the gateways for an organization are online.
xbee-factory 5
GET
/xbee-factory/{macAddress}
Return XBee factory configuration
POST
/xbee-factory/{macAddress}
Save an XBee factory configuration.
DELETE
/xbee-factory/{macAddress}
Remove a XBee factory configuration
GET
/xbee-factory/history/{macAddress}
Return XBee factory configuration history
GET
/xbee-factory/history/test-result/{macAddress}
Return XBee factory test result history
xbee-factory-update 1
POST
/xbee-factory-update/{macAddress}
Update an XBee factory configuration.
Schemas 300
The contract defines 300 schemas that model the data the API accepts and returns. The most detailed are Check (52 properties), CheckProperties (42 properties), Organization (37 properties), Widget (33 properties). Each schema is shown below with its type and property counts.
Result
object
7 properties
StackTraceElement
object
8 properties
Throwable
object
5 properties
AgentMessage
object
A message in the AI Agent conversation.
10 properties
1 required
AgentToolCall
object
An AI agent request to call a tool.
3 properties
ChunkedOutput
object
2 properties
Type
object
1 property
AgentMessageNew
object
Object holding the required properties to create a new AgentMessage.
7 properties
Assembly
object
13 properties
NewAssembly
object
13 properties
AssemblyEditable
object
8 properties
AccessToken
object
An access token used to grant authorization on certain API operations
3 properties
3 required
LicenseAccessTokenRequest
object
Request used by licenses to get an access token for authorization on certain API operations
3 properties
3 required
Assignment of a role on a resource for a user
object
4 properties
ScopesAndClaims
object
2 properties
BillingHistoryDetailsResponse
object
17 properties
BillingHistoryDetails
object
BillingHistoryDetails
14 properties
BillingHistoryDetailsUpdate
object
BillingHistoryDetailsUpdate
1 property
BillingHistoryForecastRequest
object
1 property
BillingHistoryRequest
object
3 properties
BillingHistory
object
BillingHistory
24 properties
BillingHistoryUpdate
object
BillingHistoryUpdate
6 properties
Axes
object
2 properties
2 required
Axis
object
4 properties
Chart
object
2 properties
2 required
Series
object
3 properties
1 required
Aggregation
object
Describes the aggregation for a data request.
3 properties
ScatterplotRequest
object
3 properties
3 required
Source
object
2 properties
1 required
Sources
object
2 properties
1 required
Time
object
4 properties
2 required
Crop
object
6 properties
3 required
Cultivation
object
Cultivation information for a predefined period of time along with metric targets.
24 properties
12 required
CultivationPhase
object
Contains information on a phase within the cultivation timeline.
4 properties
1 required
CultivationTarget
object
Represent a metric target for a cultivation.
9 properties
4 required
CultivationTargetSeriesResponse
object
4 properties
4 required
CultivationTargetSeriesSetpoint
object
Represents a computed datapoint in a cultivation target line series, where timestamp is expressed in epoch milliseconds
4 properties
1 required
CultivationTargetSetpoint
object
4 properties
1 required
CultivationZonesHistoryItem
object
The zones a cultivation covers since a given date
2 properties
CultivationZonesHistoryItemDetails
object
The details of the zones a cultivation covers since a given date
3 properties
Plant
object
Information on a plant within the cultivation - plant group hierarchy.
2 properties
PlantGroup
object
Contains information on a plant group within the cultivation hierarchy.
3 properties
Soil
object
8 properties
4 required
Zone
object
A Zone is a physical subsection in a site.
12 properties
4 required
CultivationTargetSeriesRequest
object
Request to retrieve cultivation target series.
3 properties
2 required
CheckProperties
object
42 properties
DataSourceCoordinatesEditable
object
Object containing the editable properties of DataSourceCoordinates.
3 properties
CalculationSettings
object
Settings used to perform a calculation.
2 properties
1 required
Check
object
A check
52 properties
19 required
CheckCollection
object
3 properties
CheckSummary
object
Summary of a check
15 properties
DataSourceCoordinates
object
Coordinates of a data source since a given timestamp.
7 properties
2 required
EventHook
object
4 properties
2 required
Notification
object
Holds the editable properties of a Notification
20 properties
1 required
SensorField
object
3 properties
StructuredConditional
object
7 properties
Sensor
object
17 properties
1 required
TransferChecksDTO
object
3 properties
MultipleCheckUpdate
object
Updating multiple checks
2 properties
AttachedDocument
object
3 properties
Comment
object
13 properties
CommentAttachments
object
2 properties
CommentTags
object
8 properties
ImageDimensions
object
2 properties
ImageThumbnail
object
4 properties
ImageWithThumbnails
object
4 properties
NewComment
object
14 properties
NewCommentReply
object
2 properties
CommentRequest
object
10 properties
PaginatedComments
object
2 properties
Pagination
object
3 properties
CommentUpdate
object
11 properties
CompanyDetails
object
14 properties
1 required
NewCompanyDetails
object
10 properties
CompanyDetailsUpdate
object
11 properties
NewCrop
object
6 properties
3 required
CropEditable
object
3 properties
CurrencyRates
object
CurrencyRates
3 properties
CurrencyRatesMapper
object
9 properties
Currency
object
3 properties
NewCurrency
object
3 properties
CustomerRegistration
object
16 properties
NewCustomerRegistration
object
15 properties
Dashboard
object
Core object in the platform used for grouping widget objects
8 properties
4 required
DashboardNew
object
Object holding the required properties to create a new dashboard
3 properties
1 required
DashboardTheme
object
8 properties
DashboardThemeCSS
object
18 properties
NewDashboardTheme
object
3 properties
1 required
DashboardThemeUpdate
object
3 properties
DashboardEditable
object
Object holding the editable properties of a dashboard
3 properties
DataExportBackgroundRequest
object
The created request to export data
15 properties
1 required
DataExportRequest
object
A request to export data
16 properties
1 required
DataExport
object
DataExport
18 properties
DataExportResponse
object
A wrapper for the data export along with the resulting document url
2 properties
DataExportCountResponse
object
1 property
1 required
NotificationTemplate
object
3 properties
SensorFieldInfo
object
4 properties
SensorType
object
Authorization entity
32 properties
2 required
SensorTypeEnumData
object
2 properties
SensorTypeEnumDataMapping
object
3 properties
SensorsData
object
4 properties
SensorsDataAggregation
object
3 properties
SensorsDataResponse
object
3 properties
1 required
SensorsDataRequest
object
2 properties
1 required
DataSourceBulkEdit
object
Object containing the editable properties of a Data Source used for bulk edit.
12 properties
1 required
DataUpload
object
DataUpload
9 properties
Device
object
A piece of mechanical or electronic equipment.
10 properties
DeviceNew
object
Object holding the properties of a new device.
6 properties
4 required
DeviceEditable
object
Object holding the editable properties of a device.
6 properties
ExportPartnerData
object
4 properties
1 required
ExportPartnerDataItem
object
3 properties
1 required
ExportPartnerJobMap
object
3 properties
1 required
NewExportPartnerJob
object
7 properties
2 required
ExportPartnerGetJobRequest
object
3 properties
2 required
ExportPartnerAccess
object
6 properties
2 required
ExportPartnerJob
object
ExportPartnerJob
11 properties
2 required
ExportPartnerJobUpdate
object
ExportPartnerJobUpdate
5 properties
NewExportPartner
object
4 properties
ExportPartner
object
ExportPartner
7 properties
ExportPartnerUpdate
object
ExportPartnerUpdate
3 properties
Gateway
object
21 properties
GatewayCluster
object
A cluster of gateways in the same wireless network.
6 properties
NewGatewayCluster
object
Gateway cluster creation properties with its restrictions.
7 properties
GatewayClusterWithSecrets
object
A cluster of gateways in the same wireless network.
6 properties
NewGateway
object
21 properties
GatewayEditable
object
14 properties
ContactMessage
object
3 properties
GroupMember
object
7 properties
NewGroupMember
object
1 property
Group
object
8 properties
NewGroup
object
4 properties
HealthResponse
object
Aggregate readiness of the API and its backing services.
3 properties
ServiceHealth
object
Readiness of a single backing service.
2 properties
Highlight
object
Information for users about platform tips, improvements or features release.
7 properties
HighlightNew
object
Object holding the required properties to create a new Highlight.
7 properties
4 required
HighlightEditable
object
Object containing the editable properties of a Highlight.
6 properties
ImportCheck
object
Import check properties
31 properties
6 required
CheckDateEntry
object
5 properties
ManualImportCheckStatsResponse
object
4 properties
1 required
ManualInputRow
object
3 properties
PaginatedManualInputRows
object
2 properties
NewCheckCollection
object
1 property
NewCheckDateEntry
object
5 properties
ExternalSensorEditable
object
20 properties
SensorCopyOverrides
object
2 properties
SensorTypeUpdate
object
Updating sensor type properties
28 properties
CheckDateEntryUpdate
object
1 property
ManualImportCheckEventDelete
object
4 properties
1 required
ImportCheckEvent
object
8 properties
2 required
ImportCheckEventFailure
object
3 properties
ImportCheckEventsResponse
object
4 properties
1 required
ManualImportCheckEventUpdateResponse
object
4 properties
1 required
ManualImportCheckEventUpdate
object
4 properties
1 required
ImportCheckEventUpdateRequest
object
6 properties
OrganizationLicense
object
A customer's physical location where data (sensors, devices and integrations) belong.
2 properties
2 required
License
object
4 properties
1 required
Address
object
The particulars of the place where this object is located.
6 properties
App
object
24 properties
1 required
CultivationPhaseDefinition
object
Organization-wide definition of a cultivation phase.
3 properties
2 required
NoteMeasurementDefinition
object
Organization-wide definition of a measurement a note can carry.
6 properties
5 required
Organization
object
An organization is an entity that encompasses a set of checks, private locations and users.
37 properties
3 required
OrganizationExtensions
object
1 property
RequiredSensor
object
3 properties
1 required
Site
object
A customer's physical location where data (sensors, devices and integrations) belong.
21 properties
4 required
Subscription
object
Object holding the editable properties of a subscription
6 properties
LicenseEditable
object
3 properties
Location
object
Monitoring location properties
17 properties
SiteEditable
object
Object that contains the editable properties of a Site
8 properties
LocationEditable
object
10 properties
MapEditable
object
Object containing the editable properties of the map of a site within an organization.
4 properties
4 required
ZoneBulkEdit
object
Object containing the editable properties of a Zone used for bulk edit.
7 properties
1 required
ConversionFormula
object
2 properties
ConversionUnit
object
5 properties
Metric
object
Metrics of sensor types
7 properties
MetricUpdate
object
Updating metric properties
6 properties
Mother
object
Mother
20 properties
NewMother
object
10 properties
LimitedScopeMother
object
7 properties
MotherStatusResponse
object
1 property
MotherTemplate
object
MotherTemplate
6 properties
NewMotherTemplate
object
3 properties
MotherTemplateUpdate
object
MotherTemplateUpdate
3 properties
MotherUpdate
object
Update Mother properties.
12 properties
NewsArticle
object
All properties of a news article.
5 properties
4 required
Note
object
Represents a note with its metadata and content.
13 properties
6 required
NoteFile
object
Represents a file attached to a note, identified by its unique identifier and MIME type.
4 properties
2 required
NoteFileDocument
object
Represents a non-image document attached to a note file.
2 properties
NoteMeasurements
object
represents measurements added to a note
4 properties
4 required
NoteNew
object
Object holding the required properties to create a new Note.
10 properties
5 required
NoteEditable
object
Object containing the editable properties of Note.
8 properties
1 required
Notification follow
object
Notification follow represents a subscription of a user to a given notification with a given method, e.g. email, sms, etc.
4 properties
NotificationFollowCount
object
2 properties
NotificationMethods
object
1 property
NotificationNew
object
Object holding the required properties to create a new notification
9 properties
3 required
NotificationEditable
object
Holds the editable properties of a Notification
8 properties
NotificationSetting
object
Notification Settings
3 properties
Follow
object
A follow represents a subscription to check's UP/DOWN changes. UP or DOWN reflects succeeded or failed url response according to the check configurations. A fo…
7 properties
1 required
NotificationSettingUpdate
object
Updating notification settings properties
1 property
NotificationTopicFollow
object
Notification topic follow
5 properties
NotificationTopicFollowCount
object
2 properties
NotificationTopic
object
Notification topic
3 properties
NewNotificationTopic
object
3 properties
NotificationTopicUpdate
object
2 properties
Offer
object
7 properties
OfferEditable
object
3 properties
NewOffer
object
7 properties
OrganizationNew
object
20 properties
3 required
OrganizationMembership
object
A user being a member of an organization with a given role.
6 properties
1 required
OrganizationWithUserRole
object
2 properties
NewSite
object
A customer's physical location where data (sensors, devices and integrations) belong.
20 properties
4 required
OrganizationEditable
object
19 properties
OrganizationMembershipUpdate
object
Update the role of a user within an organization.
1 property
Partner
object
4 properties
NewPartner
object
4 properties
PartnerEditable
object
1 property
Pricing
object
Pricing
10 properties
PricingUpdate
object
PricingUpdate
9 properties
Product
object
Product
21 properties
1 required
NewProduct
object
18 properties
1 required
ProductUpdate
object
Updating product properties.
17 properties
VoltageResponse
object
1 property
SharedByUserDetails
object
2 properties
SharedSensorType
object
13 properties
SharedWithUserDetails
object
2 properties
SharedCheck
object
14 properties
SharedWithGroupDetails
object
2 properties
NewSharedCheck
object
5 properties
DashboardSummary
object
Summary of a dashboard
3 properties
SharedDashboard
object
11 properties
NewSharedDashboard
object
2 properties
SharedDashboardUpdate
object
Updating shared dashboard properties
1 property
NewSoil
object
8 properties
4 required
SoilEditable
object
4 properties
SubscriptionAssignment
object
6 properties
SubscriptionNew
object
Object holding the editable properties of a subscription
4 properties
3 required
SubscriptionEditable
object
Object holding the editable properties of a subscription
2 properties
TimezoneDetails
object
3 properties
UserConfig
object
4 properties
2 required
UserConfigEditable
object
2 properties
User
object
A person who uses the platform
14 properties
1 required
WebPageReference
object
A reference to a web page
2 properties
SignUpRequest
object
Payload submitted by an invited user to sign up.
3 properties
2 required
Credential
object
Object holding user's credentials
3 properties
UserCredentialsAsGuest
object
Object holding the required properties to register a guest
5 properties
UserNew
object
Object holding the required properties to create a new user
11 properties
3 required
UserInviteRequest
object
User Invite to an organization
14 properties
5 required
UserToken
object
1 property
UserEditable
object
Object holding the editable properties of a user
10 properties
ChartAxis
object
4 properties
ChartConfiguration
object
5 properties
Data
object
5 properties
Scope
object
6 properties
Widget
object
A dashboard widget
33 properties
NewWidget
object
24 properties
WidgetUpdate
object
Updating widget properties
21 properties
ZoneNew
object
Object holding the required properties to create a new Zone.
6 properties
1 required
ZoneEditable
object
Object holding the editable properties of a Zone.
6 properties
AppInstallation
object
18 properties
3 required
NewAppInstallation
object
3 properties
AppInstallationEditable
object
3 properties
AppEditable
object
14 properties
Calculation
object
Calculations allow querying data through operations and aggregations.
5 properties
NewCalculation
object
Object holding the properties of a new calculation.
8 properties
2 required
CalculationEditable
object
Object holding the editable properties of a calculation.
8 properties
DropResponse
object
8 properties
CheckStatsRequest
object
10 properties
CustomerRequestItem
object
CustomerRequestItem
12 properties
3 required
NewCustomerRequestItem
object
7 properties
2 required
CustomerRequestItemUpdate
object
Update quote item properties
9 properties
CustomerRequest
object
Customer request
33 properties
1 required
NewCustomerRequest
object
24 properties
1 required
CustomerRequestUpdate
object
Update customer request properties
29 properties
Dealer
object
13 properties
DealerUpdate
object
12 properties
Invoice
object
Invoice
11 properties
NewInvoice
object
6 properties
InvoiceUpdate
object
Updating of an invoice
5 properties
Order
object
Order
13 properties
NewOrder
object
6 properties
OrderUpdate
object
Updating of an order
5 properties
Quote
object
updating of a quote
5 properties
NewQuote
object
6 properties
CultivationNew
object
Object holding the required properties to create a new Cultivation.
17 properties
6 required
CultivationEditable
object
Object containing the editable properties of Cultivation.
15 properties
CultivationTargetEditable
object
Object containing the editable properties of CultivationTarget.
4 properties
CultivationTargetNew
object
Object holding the required properties to create a new CultivationTarget.
6 properties
4 required
ResponseEntry
object
Aggregation statistical result entity
1 property
StatisticsInfoRequest
object
13 properties
CheckLastRecordedStatInfo
object
8 properties
EventsCount
object
1 property
NetworkOverviewResponse
object
15 properties
CheckUptimeResponse
object
6 properties
IngestStatusResponse
object
3 properties
TwoValuesComparison
object
6 properties
TwoValuesComparisonTableScan
object
5 properties
DeviceStatusResponse
object
Online/offline status of mother devices. isOnline is true when any of the devices is online.
3 properties
XBeeFactory
object
7 properties
XBeeConfiguration
object
3 properties
XBeeTestResult
object
3 properties
XBeeFactoryEditable
object
4 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
#Horticulture#Sensors#Internet of Things#Greenhouse#Climate Monitoring#Time Series Data
Where this information came from
This is an independent, third-party profile of ZENSIE API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.