search

Share

Sensor sharing and unsharing

hashtag
Share a sensor with another user

post
/share

Shares your sensor data with another user via their e-mail address. This grants them access to the sensor data via the get endpoint.

A notification e-mail will be sent to the target user about the new share. If the target user does not exist yet, an invitation to create an account will be sent and they will gain access upon sign up.

The features share receiver gets are based on your account type - if you have a Pro account, the share receiver also gets Pro features for this sensor.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
sensorstringRequired

MAC address of the sensor to share (e.g. C6:F1:E7:D3:DA:11)

Pattern: ^([0-9A-Fa-f]{2}:){5}[0-9A-Fa-f]{2}$
userstring · emailRequired

E-mail address of the user to share the sensor with

Responses
chevron-right
200

Sensor shared successfully

application/json
post
/share

hashtag
Unshare a sensor from a user

post
/unshare

Revokes access to the sensor from a target user.

This can also be used to remove sensors that have been shared with your own user (i.e., declining a share from someone else).

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
sensorstringRequired

MAC address of the sensor to unshare (e.g. C6:F1:E7:D3:DA:11)

Pattern: ^([0-9A-Fa-f]{2}:){5}[0-9A-Fa-f]{2}$
userstring · emailOptional

E-mail address of the user to revoke access from. If omitted, the share is removed from the authenticated user's account (useful for declining a share someone else made to you).

Responses
chevron-right
200

Sensor unshared successfully

application/json
post
/unshare
PreviousPush NotificationsNextSubscription

Last updated