Skip to main content
GET
/
land
/
descriptions
List Land Descriptions
curl --request GET \
  --url https://v1.api.flux-os.com/land/descriptions \
  --header 'x-api-key: <api-key>' \
  --header 'x-user-id: <api-key>'
{
  "data": [
    {
      "description": "<string>",
      "latitude": 123,
      "longitude": 123,
      "id": "<string>",
      "survey_system": {
        "name": "<string>",
        "short_code": "<string>",
        "id": "<string>"
      },
      "unit": {
        "name": "<string>",
        "short_code": "<string>",
        "id": "<string>"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "current_page": 123,
    "total_pages": 123,
    "total_items": 123,
    "per_page": 123
  }
}

Authorizations

x-api-key
string
header
required
x-user-id
string
header
required

Query Parameters

page
integer
default:1

Page number for pagination

Required range: x >= 1

Response

A paginated list of land descriptions.

data
object[]
meta
object