API Reference

TIP

For instructions how to use the GreenHub API, please read this first.

Index

GreenHub API URL: https://farmer.greenhubproject.org/api/ .

All actions that require authentication you need to provide an API token with the request. See Authentication for more details.

Method	Endpoint	Usage	Returns	Auth*
GET	/v1/me	Get The User’s Profile	User	Yes
PUT	/v1/me/token	Generate New API Key	string	Yes
GET	/v1/devices	List Devices	Devices	Yes
GET	/v1/devices/:id	Get A Device	Device	Yes
GET	/v1/devices/:id/samples	Get A Device's Samples	Samples	Yes
GET	/v1/samples	List Samples	Samples	Yes
GET	/v1/samples/:id	Get A Sample	Sample	Yes
GET	/v1/samples/:id/device	Get A Sample's Device	Device	Yes
GET	/v1/cpu-statuses	List CPU Statuses	CPU Status	Yes
GET	/v1/cpu-statuses/:id	Get A CPU Status	CPU Status	Yes
GET	/v1/battery-details	List Battery Details	Battery Details	Yes
GET	/v1/battery-details/:id	Get A Battery Details	Battery Details	Yes
GET	/v1/network-details	List Network Details	Network Details	Yes
GET	/v1/network-details/:id	Get A Network Details	Network Details	Yes
GET	/v1/storage-details	List Storage Details	Storage Details	Yes
GET	/v1/storage-details/:id	Get A Storage Details	Storage Details	Yes
GET	/v1/settings	List Settings	Settings	Yes
GET	/v1/settings/:id	Get A Settings	Settings	Yes

*Request authentication

Current User

User Object

User object represents a person who has a valid GreenHub Farmer account.

Key	Type	Description
id	integer	ID of the user.
name	string	Name of user.
email	string	Email address of user.
verified	boolean	Whether user account is verified.
created_at	timestamp	Datetime when the record was created.
updated_at	timestamp	Datetime when the record was last updated.

Get Current User’s Profile

Get detailed profile information about the current user.

GET /v1/me

Authentication

Yes

Parameters

None

Response

200 OK
X-Ratelimit-Limit: 60
X-Ratelimit-Remaining: 59

{
  "data": {
    "created_at": "2017-10-17 18:27:02",
    "email": "johndoe@example.com",
    "id": 1,
    "name": "John Doe",
    "updated_at": "2017-10-26 18:27:49",
    "verified": true
  }
}

Example Request

$ curl -i -X GET "https://farmer.greenhubproject.org/api/v1/me" -H "Authorization: Bearer {your api key}"

Generate New API Key

Generate a new API token key for the current user.

PUT /v1/me/token

Authentication

Yes

Parameters

None

Response

200 OK
X-Ratelimit-Limit: 60
X-Ratelimit-Remaining: 59

{
  "data": {
    "api_token": "{new api token here}"
  }
}

Example Request

$ curl -i -X PUT "https://farmer.greenhubproject.org/api/v1/me/token" -H "Authorization: Bearer {your api key}"

Devices

Device Object

Device object represents an Android device registered on the API server.A registration is one installation of the app BatteryHub on the device. In case a device installs the app BatteryHub more than once, one device object will be created per each installation.

Key	Type	Description
id	integer	ID of the device.
model	string	Model of device.
manufacturer	string	Brand of device.
product	string	Product name of device.
os_version	string	Android OS version of device.
kernel_version	string	Unix kernel version of device.
is_root	boolean	Whether device has root access.
created_at	datetime	Timestamp when the record was created.
updated_at	datetime	Timestamp when the record was last updated.

List Devices

Get a single page from the list of all devices.

GET /v1/devices

Authentication

Yes

Parameters

All parameters are optional.

Param	Description
page	Page number to retrieve. (Default: 1)
per_page	Number of items per page. (Default: 10)

Response

200 OK
X-Ratelimit-Limit: 60
X-Ratelimit-Remaining: 59

{
  "data": [
    {
      "brand": "asus",
      "created_at": "2017-10-28 02:51:09",
      "id": 2518,
      "is_root": false,
      "kernel_version": "3.1835+",
      "manufacturer": "asus",
      "model": "ASUS_X008D",
      "product": "WW_Phone",
      "os_version": "7.0",
      "updated_at": "2017-10-28 02:51:09"
    },
    {
      "brand": "samsung",
      "created_at": "2017-10-28 06:24:32",
      "id": 2519,
      "is_root": false,
      "kernel_version": "3.18.14-11104523",
      "manufacturer": "samsung",
      "model": "SM-G930F",
      "product": "heroltexx",
      "os_version": "7.0",
      "updated_at": "2017-10-28 06:24:32"
    }
  ],
  "links": {
    "first": "https://farmer.greenhubproject.org/api/v1/devices?page=1",
    "last": null,
    "prev": null,
    "next": "https://farmer.greenhubproject.org/api/v1/devices?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "path": "https://farmer.greenhubproject.org/api/v1/devices",
    "per_page": 10,
    "to": 2
  }
}

Example Request

$ curl -i -X GET "https://farmer.greenhubproject.org/api/v1/devices" -H "Authorization: Bearer {your api key}"

Get A Device

Retrieve a single device.

GET /v1/devices/:id

Authentication

Yes

Parameters

Param	Description
id	The device's ID. Required

Response

200 OK
X-Ratelimit-Limit: 60
X-Ratelimit-Remaining: 59

{
  "data": {
    "brand": "google",
    "created_at": "2017-10-17 21:52:45",
    "id": 1234,
    "is_root": false,
    "kernel_version": "3.4.0-gcf10b7e",
    "manufacturer": "LGE",
    "model": "Nexus 5",
    "os_version": "6.0.1",
    "product": "hammerhead",
    "updated_at": "2017-10-17 21:52:45"
  }
}

Example Request

$ curl -i -X GET "https://farmer.greenhubproject.org/api/v1/devices/1234" -H "Authorization: Bearer {your api key}"

Get A Device's Samples

Get a list of samples uploaded by a device.

See the documentation about the Sample object.

GET /v1/devices/:id/samples

Authentication

Yes

Parameters

Param	Description
id	The device's ID. Required
page	Page number to retrieve. Optional (Default: 1)
per_page	Number of items per page. Optional (Default: 10)

Response

200 OK
X-Ratelimit-Limit: 60
X-Ratelimit-Remaining: 59

{
  "data": [
    {
      "app_version": 14,
      "battery_level": 0.99,
      "battery_state": "Discharging",
      "country_code": "Unknown",
      "created_at": "2017-10-25 18:17:37",
      "database_version": 3,
      "id": 98,
      "memory_active": 1025820,
      "memory_free": 1899508,
      "memory_inactive": 420244,
      "memory_user": 173044,
      "memory_wired": 0,
      "network_status": "WIFI",
      "screen_brightness": -1,
      "screen_on": true,
      "timestamp": "2017-10-25 18:04:34",
      "timezone": "Europe/Lisbon",
      "triggered_by": "android.intent.action.BATTERY_CHANGED",
      "updated_at": "2017-10-25 18:17:37"
    },
    {
      "app_version": 14,
      "battery_level": 0.98,
      "battery_state": "Discharging",
      "country_code": "Unknown",
      "created_at": "2017-10-25 18:17:38",
      "database_version": 3,
      "id": 99,
      "memory_active": 1021292,
      "memory_free": 1899508,
      "memory_inactive": 418888,
      "memory_user": 178000,
      "memory_wired": 0,
      "network_status": "WIFI",
      "screen_brightness": -1,
      "screen_on": true,
      "timestamp": "2017-10-25 18:04:56",
      "timezone": "Europe/Lisbon",
      "triggered_by": "android.intent.action.BATTERY_CHANGED",
      "updated_at": "2017-10-25 18:17:38"
    }
  ],
  "links": {
    "first": "https://farmer.greenhubproject.org/api/v1/devices/1234/samples?page=1",
    "last": null,
    "next": null,
    "prev": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "path": "https://farmer.greenhubproject.org/api/v1/devices/1234/samples",
    "per_page": 10,
    "to": 2
  }
}

Example Request

$ curl -i -X GET "https://farmer.greenhubproject.org/api/v1/devices/1234/samples" -H "Authorization: Bearer {your api key}"

Samples

Sample Object

Sample object represents a snapshot of the Android device, it is a summary of its current state containing information ranging from battery status, network, screen state and memory usage. It also contains important information about the datetime when the sample was obtained, as well the BatteryHub version that originated the sample.

Key	Type	Description
id	integer	ID of the sample.
timestamp	datetime	Timestamp when the sample was created on the device.
app_version	integer	BatteryHub app version.
database_version	integer	BatteryHub database version.
battery_state	string	State of battery. Can be Charging , Discharging , Full , Not Charging or Unknown .
battery_level	float	Battery Level. Ranges from 0.0 to 1.0 .
triggered_by	string	The event (Android action intent) that triggered the sample collection.
network_status	string	State of network. Can be WIFI , lte or disconnected .
screen_brightness	integer	Screen brightness value between 0 and 255 , -1 if set to automatic otherwise.
screen_on	boolean	Either if screen is on or off.
timezone	string	Current timezone of the mobile device.
country_code	string	Current network ISOBattery Details country code.
created_at	datetime	Timestamp when the record was created.
updated_at	datetime	Timestamp when the record was last updated.

List Samples

Get a single page from the list of all samples.

GET /v1/samples

Authentication

Yes

Parameters

All parameters are optional.

Param	Description
page	Page number to retrieve. (Default: 1)
per_page	Number of items per page. (Default: 10)

Response

200 OK
X-Ratelimit-Limit: 60
X-Ratelimit-Remaining: 59

{
  "data": [
    {
      "id": 1,
      "device_id": 1,
      "timestamp": "2017-10-08 12:50:04",
      "app_version": 11,
      "database_version": 0,
      "battery_state": "discharging",
      "battery_level": 0.82,
      "triggered_by": "android.intent.action.BATTERY_CHANGED",
      "network_status": "wifi",
      "screen_brightness": -1,
      "screen_on": true,
      "timezone": "America/Chicago",
      "country_code": "us",
      "created_at": "2017-10-09 03:48:00",
      "updated_at": "2017-10-09 03:48:00"
    },
    {
      "id": 2,
      "device_id": 1,
      "timestamp": "2017-10-08 12:50:04",
      "app_version": 11,
      "database_version": 0,
      "battery_state": "discharging",
      "battery_level": 0.82,
      "triggered_by": "android.intent.action.BATTERY_CHANGED",
      "network_status": "wifi",
      "screen_brightness": -1,
      "screen_on": true,
      "timezone": "America/Chicago",
      "country_code": "us",
      "created_at": "2017-10-09 03:51:23",
      "updated_at": "2017-10-09 03:51:23"
    }
  ],
  "links": {
    "first": "https://farmer.greenhubproject.org/api/v1/samples?page=1",
    "last": null,
    "prev": null,
    "next": "https://farmer.greenhubproject.org/api/v1/samples?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "path": "https://farmer.greenhubproject.org/api/v1/samples",
    "per_page": "2",
    "to": 2
  }
}

Example Request

$ curl -i -X GET "https://farmer.greenhubproject.org/api/v1/samples?per_page=2" -H "Authorization: Bearer {your api key}"

Get A Sample

Retrieve a single sample.

GET /v1/samples/:id

Authentication

Yes

Parameters

Param	Description
id	The sample's ID. Required

Response

200 OK
X-Ratelimit-Limit: 60
X-Ratelimit-Remaining: 59

{
  "data": {
    "id": 1234,
    "device_id": 135,
    "timestamp": "2017-10-09 12:10:31",
    "app_version": 11,
    "database_version": 3,
    "battery_state": "charging",
    "battery_level": 0.72,
    "triggered_by": "android.intent.action.BATTERY_CHANGED",
    "network_status": "disconnected",
    "screen_brightness": -1,
    "screen_on": false,
    "timezone": "Europe/Lisbon",
    "country_code": "pt",
    "created_at": "2017-10-09 14:13:56",
    "updated_at": "2017-10-09 14:13:56"
  }
}

Example Request

$ curl -i -X GET "https://farmer.greenhubproject.org/api/v1/samples/1234" -H "Authorization: Bearer {your api key}"

Get A Sample's Device

Retrieve a single sample's.

GET /v1/samples/:id/device

Authentication

Yes

Parameters

Param	Description
id	The sample's ID. Required

Response

200 OK
X-Ratelimit-Limit: 60
X-Ratelimit-Remaining: 59

{
  "data": {
    "id": 40,
    "model": "SM-G920F",
    "manufacturer": "samsung",
    "brand": "samsung",
    "product": "zerofltexx",
    "os_version": "7.0",
    "kernel_version": "3.10.61-10940776",
    "is_root": false,
    "created_at": "2017-10-09 10:27:44",
    "updated_at": "2017-10-09 10:27:44"
  }
}

Example Request

$ curl -i -X GET "https://farmer.greenhubproject.org/api/v1/samples/1000/device" -H "Authorization: Bearer {your api key}"

CPU Statuses

CPU Status Object

CPU Status object represents the state of the device's CPU at the time the associated sample is obtained. Contains information about its usage, up and sleep time.

Key	Type	Description
id	integer	ID of the CPU status.
sample_id	integer	ID of the sample that it belongs to.
usage	float	Fraction of cpu being used.
up_time	integer	Up time in seconds.
sleep_time	integer	Sleep time in seconds.
created_at	datetime	Timestamp when the record was created.
updated_at	datetime	Timestamp when the record was last updated.

List CPU Statuses

Get a single page from the list of all cpu statuses.

GET /v1/cpu-statuses

Authentication

Yes

Parameters

All parameters are optional.

Param	Description
page	Page number to retrieve. (Default: 1)
per_page	Number of items per page. (Default: 10)

Response

200 OK
X-Ratelimit-Limit: 60
X-Ratelimit-Remaining: 59

Example Request

$ curl -i -X GET "https://farmer.greenhubproject.org/api/v1/cpu-statuses?per_page=2" -H "Authorization: Bearer {your api key}"

Get A CPU Status

Retrieve a single CPU status.

GET /v1/cpu-statuses/:id

Authentication

Yes

Parameters

Param	Description
id	The CPU status's ID. Required

Response

200 OK
X-Ratelimit-Limit: 60
X-Ratelimit-Remaining: 59

Example Request

$ curl -i -X GET "https://farmer.greenhubproject.org/api/v1/cpu-statuses/1234" -H "Authorization: Bearer {your api key}"

Battery Details

Battery Details Object

Battery Details object represents a set of extra information regarding the device's physical battery condition at the time the associated sample is obtained.

Key	Type	Description
id	integer	ID of the battery details.
sample_id	integer	ID of the sample that it belongs to.
charger	string	Type of charger. Can be ac, usb or unplugged.
health	string	Battery's health. Can be Unknown, Unspecified failure, Dead, Cold, Overheat, Over voltage, Good.
voltage	float	Battery's voltage in volts.
temperature	float	Battery's temperature in celsius degrees.
created_at	datetime	Timestamp when the record was created.
updated_at	datetime	Timestamp when the record was last updated.

List Battery Details

Get a single page from the list of all battery details.

GET /v1/battery-details

Authentication

Yes

Parameters

All parameters are optional.

Param	Description
page	Page number to retrieve. (Default: 1)
per_page	Number of items per page. (Default: 10)

Response

200 OK
X-Ratelimit-Limit: 60
X-Ratelimit-Remaining: 59

{
  "data": [
    {
      "id": 1,
      "sample_id": 1,
      "charger": "unplugged",
      "health": "Good",
      "voltage": "4.05",
      "temperature": "28.50",
      "capacity": 0,
      "charge_counter": 0,
      "current_average": 0,
      "current_now": -229,
      "energy_counter": -1,
      "created_at": "2017-10-09 03:48:00",
      "updated_at": "2017-10-09 03:48:00"
    },
    {
      "id": 2,
      "sample_id": 2,
      "charger": "unplugged",
      "health": "Good",
      "voltage": "4.05",
      "temperature": "28.50",
      "capacity": 0,
      "charge_counter": 0,
      "current_average": 0,
      "current_now": -229,
      "energy_counter": -1,
      "created_at": "2017-10-09 03:51:23",
      "updated_at": "2017-10-09 03:51:23"
    }
  ],
  "links": {
    "first": "https://farmer.greenhubproject.org/api/v1/battery-details?page=1",
    "last": null,
    "prev": null,
    "next": "https://farmer.greenhubproject.org/api/v1/battery-details?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "path": "https://farmer.greenhubproject.org/api/v1/battery-details",
    "per_page": "2",
    "to": 2
  }
}

Example Request

$ curl -i -X GET "https://farmer.greenhubproject.org/api/v1/battery-details?per_page=2" -H "Authorization: Bearer {your api key}"

Get A Battery Details

Retrieve a single Battery details.

GET /v1/battery-details/:id

Authentication

Yes

Parameters

Param	Description
id	The battery details's ID. Required

Response

200 OK
X-Ratelimit-Limit: 60
X-Ratelimit-Remaining: 59

{
  "data": {
    "id": 2222,
    "sample_id": 2222,
    "charger": "usb",
    "health": "Good",
    "voltage": "4.08",
    "temperature": "29.80",
    "capacity": 0,
    "charge_counter": 0,
    "current_average": 0,
    "current_now": 626,
    "energy_counter": -1,
    "created_at": "2017-10-09 15:22:16",
    "updated_at": "2017-10-09 15:22:16"
  }
}

Example Request

$ curl -i -X GET "https://farmer.greenhubproject.org/api/v1/battery-details/2222" -H "Authorization: Bearer {your api key}"

Network Details

Network Details Object

Network Details object represents a set of extra information regarding the device's networks at the time the associated sample is obtained.

Key	Type	Description
id	integer	ID of the network details.
sample_id	integer	ID of the sample that it belongs to.
network_type	string	Network's type. Can be wifi, mobile or unknown.
mobile_network_type	string	Mobile network's type. Some possible values can be GPRS, EDGE, UMTS, etc.
mobile_data_status	string	Mobile data current status. Can be connecting, connected, disconnected or suspended.
mobile_data_activity	string	Mobile data current activity state. Can be none, in, out, inout, dormant.
roaming_enabled	boolean	Either if roaming is enabled or disabled.
wifi_status	string	Wi-Fi current status. Can be disabled, disabling, enabled, enabling, unknown.
wifi_signal_strength	integer	Wi-Fi signal strength in dBm.
wifi_link_speed	integer	Wi-Fi link speed in Mbps.
wifi_ap_status	string	Wi-Fi access point current status. Can be disabled, disabling, enabled, enabling, unknown.
network_operator	string	Network infrastructure provider's name.
sim_operator	string	Service provider's name bound to SIM card.
mcc	string	Numeric country code.
mnc	string	Numeric network code.
created_at	datetime	Timestamp when the record was created.
updated_at	datetime	Timestamp when the record was last updated.

List Network Details

Get a single page from the list of all network details.

GET /v1/network-details

Authentication

Yes

Parameters

All parameters are optional.

Param	Description
page	Page number to retrieve. (Default: 1)
per_page	Number of items per page. (Default: 10)

Response

200 OK
X-Ratelimit-Limit: 60
X-Ratelimit-Remaining: 59

{
  "data": [
    {
      "id": 1,
      "sample_id": 1,
      "network_type": "WIFI",
      "mobile_network_type": "lte",
      "mobile_data_status": "disconnected",
      "mobile_data_activity": "none",
      "roaming_enabled": 0,
      "wifi_status": "enabled",
      "wifi_signal_strength": -56,
      "wifi_link_speed": 72,
      "wifi_ap_status": "disabled",
      "network_operator": "Verizon",
      "sim_operator": "unknown",
      "mcc": "311",
      "mnc": "480",
      "created_at": "2017-10-09 03:48:00",
      "updated_at": "2017-10-09 03:48:00"
    },
    {
      "id": 2,
      "sample_id": 2,
      "network_type": "WIFI",
      "mobile_network_type": "lte",
      "mobile_data_status": "disconnected",
      "mobile_data_activity": "none",
      "roaming_enabled": 0,
      "wifi_status": "enabled",
      "wifi_signal_strength": -56,
      "wifi_link_speed": 72,
      "wifi_ap_status": "disabled",
      "network_operator": "Verizon",
      "sim_operator": "unknown",
      "mcc": "311",
      "mnc": "480",
      "created_at": "2017-10-09 03:51:23",
      "updated_at": "2017-10-09 03:51:23"
    }
  ],
  "links": {
    "first": "https://farmer.greenhubproject.org/api/v1/network-details?page=1",
    "last": null,
    "prev": null,
    "next": "https://farmer.greenhubproject.org/api/v1/network-details?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "path": "https://farmer.greenhubproject.org/api/v1/network-details",
    "per_page": "2",
    "to": 2
  }
}

Example Request

$ curl -i -X GET "https://farmer.greenhubproject.org/api/v1/network-details?per_page=2" -H "Authorization: Bearer {your api key}"

Get A Network Details

Retrieve a single Network details.

GET /v1/network-details/:id

Authentication

Yes

Parameters

Param	Description
id	The network details's ID. Required

Response

200 OK
X-Ratelimit-Limit: 60
X-Ratelimit-Remaining: 59

{
  "data": {
    "id": 1234,
    "sample_id": 1234,
    "network_type": "unknown",
    "mobile_network_type": "utms",
    "mobile_data_status": "disconnected",
    "mobile_data_activity": "none",
    "roaming_enabled": 0,
    "wifi_status": "enabled",
    "wifi_signal_strength": -200,
    "wifi_link_speed": -1,
    "wifi_ap_status": "disabled",
    "network_operator": "MEO",
    "sim_operator": "MEO",
    "mcc": "268",
    "mnc": "06",
    "created_at": "2017-10-09 14:13:56",
    "updated_at": "2017-10-09 14:13:56"
  }
}

Example Request

$ curl -i -X GET "https://farmer.greenhubproject.org/api/v1/network-details/1234" -H "Authorization: Bearer {your api key}"

Storage Details

Storage Details Object

Storage Details object represents the device's storage usage information at the time the associated sample is obtained. Storage unit is Kilobytes.

Key	Type	Description
id	integer	ID of the storage details.
sample_id	integer	ID of the sample that it belongs to.
free	integer	Overall free storage space.
total	integer	Overall total storage space.
free_external	integer	External storage free space.
total_external	integer	External storage total space.
free_system	integer	System storage free space.
total_system	integer	System storage total space.
free_secondary	integer	Secondary storage free space.
total_secondary	integer	Secondary storage total space.
created_at	datetime	Timestamp when the record was created.
updated_at	datetime	Timestamp when the record was last updated.

List Storage Details

Get a single page from the list of all storage details.

GET /v1/storage-details

Authentication

Yes

Parameters

All parameters are optional.

Param	Description
page	Page number to retrieve. (Default: 1)
per_page	Number of items per page. (Default: 10)

Response

200 OK
X-Ratelimit-Limit: 60
X-Ratelimit-Remaining: 59

Example Request

$ curl -i -X GET "https://farmer.greenhubproject.org/api/v1/storage-details?per_page=2" -H "Authorization: Bearer {your api key}"

Get A Storage Details

Retrieve a single Storage Details.

GET /v1/storage-details/:id

Authentication

Yes

Parameters

Param	Description
id	The storage details's ID. Required

Response

200 OK
X-Ratelimit-Limit: 60
X-Ratelimit-Remaining: 59

Example Request

$ curl -i -X GET "https://farmer.greenhubproject.org/api/v1/storage-details/1234" -H "Authorization: Bearer {your api key}"

Settings

Settings Object

Settings object represents a set of device's configuration at the time the associated sample is obtained. Contains information regarding which components are switch on or off.

Key	Type	Description
id	integer	ID of the settings.
sample_id	integer	ID of the sample that it belongs to.
bluetooth_enabled	boolean	Either if bluetooth is on or off.
location_enabled	boolean	Either if GPS is on or off.
power_saver_enabled	boolean	Either if power saver mode is enabled or disabled.
flashlight_enabled	boolean	Either if flashlight is on or off.
nfc_enabled	boolean	Either if NFC sensor is on or off.
unknown_sources	boolean	Either if system setting for apps of unknown sources can be installed or not.
developer_mode	boolean	Either if developer mode is enabled or disabled.
created_at	datetime	Timestamp when the record was created.
updated_at	datetime	Timestamp when the record was last updated.

List Settings

Get a single page from the list of all settings.

GET /v1/settings

Authentication

Yes

Parameters

All parameters are optional.

Param	Description
page	Page number to retrieve. (Default: 1)
per_page	Number of items per page. (Default: 10)

Response

200 OK
X-Ratelimit-Limit: 60
X-Ratelimit-Remaining: 59

Example Request

$ curl -i -X GET "https://farmer.greenhubproject.org/api/v1/settings?per_page=2" -H "Authorization: Bearer {your api key}"

Get A Settings

Retrieve a single settings.

GET /v1/settings/:id

Authentication

Yes

Parameters

Param	Description
id	The settings's ID. Required

Response

200 OK
X-Ratelimit-Limit: 60
X-Ratelimit-Remaining: 59

Example Request

$ curl -i -X GET "https://farmer.greenhubproject.org/api/v1/settings/1234" -H "Authorization: Bearer {your api key}"