v1
latestOpenAPI 3.0.02026-07-132849114.2 KBFields
Retrieve list of Fields
Retrieve list of Fields. Filter the results by field name if the fieldName query parameter is specified.
get/v4/fields
Query parameters
fieldNamestring
Optional prefix filter for field name. Must be at least 3 characters.
Headers
X-Next-Tokenstring
Opaque string which allows for fetching the next batch of results. Can be used to poll for changes.
X-Limitinteger
Max number of results to return per batch. Must be between 1 and 100 inclusive. Defaults to 100.
Response
OK
Example response
{
"results": [
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "Back Forty",
"boundaryId": "00000000-0000-0000-0000-000000000000",
"resourceOwnerId": "00000000-0000-0000-0000-000000000000",
"parent": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "farm"
}
}
]
}