Skip to content

Get custom field

Request

Security
ApiKeyAuth
Path
idstringrequired
Query
orderingstring

Which field to use when ordering the results.

searchstring

A search term.

is_activeboolean

Filter by active status (true/false)

group_idinteger

Filter by group ID (integer)

entity_typestring

Filter by entity type

Enum:"property""owner"
curl -i -X GET \
  'https://apiv2.reisift.io/api/internal/custom-fields/{id}/?ordering=string&search=string&is_active=true&group_id=0&entity_type=property' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
entity_typestringrequired
Enum:"property""owner"
labelstring, <= 255 charactersrequired
field_typestringrequired
Enum:"text""text_input""url""boolean""number""phone""money""date""select""multiselect"
idintegerread-only
groupobjectread-only
uuidstring, (uuid)read-only
requiredboolean
positioninteger, [ -2147483648 .. 2147483647 ]
is_activeboolean
optionsArray of objects
createdstring, (date-time)read-only
updatedstring, (date-time)read-only
account_idintegerread-only
machine_namestring or nullread-only

Machine-friendly key for integrations, e.g., 'custom_field'

placeholderstring or null, <= 255 characters

Optional placeholder text for the custom_field

Response
{ "id": 0, "entity_type": "property", "group": { "id": 0, "label": "string" }, "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f", "label": "string", "field_type": "text", "required": true, "position": -2147483648, "is_active": true, "options": [ { … } ], "created": "2019-08-24T14:15:22Z", "updated": "2019-08-24T14:15:22Z", "account_id": 0, "machine_name": "string", "placeholder": "string" }