Skip to navigation
API ReferenceField Requests

Get Field Request

Returns a single field request by ID.

Requires scope: field_requests:read

Authentication

API_KEYstring
API Key authentication via header

Path parameters

idUUIDRequired
Field request ID.

Response

This endpoint returns an object.
idUUID
Unique identifier for the field request.
numberlong

Auto-generated sequential reference number for the field request.

createdAtdatetime
ISO 8601 timestamp when the record was created.
updatedAtdatetime
ISO 8601 timestamp when the record was last updated.
namestringOptional
Name or short description of the field request.
statusenumOptional
Current status of the field request.
priorityStatusenumOptional
Priority level assigned to the field request.
Allowed values:
notesstringOptional
Additional notes or details about the request.
dueDatedatetimeOptional
ISO 8601 timestamp for when the request is due.
locationobjectOptional
Reference to the location associated with this request.
createdByobjectOptional
Reference to the user who created the field request.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Rate Limit Error