# Search Object Fields API

{% hint style="success" %}
**Audience:** Developers and Integration Engineers

**Purpose:** Explains how to retrieve filtered field metadata for a specific <code class="expression">space.vars.object</code> without requesting full <code class="expression">space.vars.object</code> configuration details
{% endhint %}

## Overview

Use the **Search for Object Fields** endpoint to retrieve field definitions for a specific <code class="expression">space.vars.object</code> using structured query criteria.

This endpoint supports schema discovery and schema-aware integrations by enabling external systems to locate fields by type or configuration, validate field availability, and retrieve field-level metadata without loading full <code class="expression">space.vars.object</code> details. Because field configurations may vary across <code class="expression">space.vars.objects</code> or environments, searching fields dynamically helps integrations remain adaptable and efficient.

Unlike the [Retrieve Object Details by ID API](/docs/concepts/objects/object-apis/retrieve-object-details-by-id-api.md), this endpoint focuses exclusively on field-level metadata and supports filtering to reduce response size and improve performance.

The material on this page builds on information covered in [Objects Core Concepts](/docs/concepts/objects/object-core-concepts.md) and the [Object Data Model](/docs/concepts/objects/object-data-model.md).

### Why Use This API?

You can use the Search <code class="expression">space.vars.object</code> Fields API when you need to:

* Dynamically retrieve field metadata for a specific <code class="expression">space.vars.object</code>
* Identify fields by type (For Example: dropdown, relationship, money, date)
* Validate that required fields exist before sending <code class="expression">space.vars.entity</code> updates
* Confirm whether fields allow null or empty values
* Retrieve only numeric fields for reporting or calculations
* Filter fields by category for UI rendering or form generation
* Reduce payload size when full <code class="expression">space.vars.object</code> configuration is unnecessary
* Build schema-aware integrations that adapt to configuration changes

This endpoint is especially useful when your integration needs precise field-level metadata without loading layouts, workflows, related <code class="expression">space.vars.objects</code>, or other <code class="expression">space.vars.object</code>-level configuration details.

### Search for Custom Object Fields API Behavior

The Search for <code class="expression">space.vars.object</code> Fields endpoint searches for fields within a single custom <code class="expression">space.vars.object</code> and returns only the matching field definitions. The search is limited to the specified `object_pk`. It does not return object-level details such as layouts, workflows, related <code class="expression">space.vars.objects</code>, or actions.

Results are returned as a simple array of field <code class="expression">space.vars.objects</code> (not paginated). You can use query parameters to filter by:

* Field type
* Category
* Default status
* Numeric fields
* Text search

The response format is the same field metadata structure returned by the <code class="expression">space.vars.object</code> Detail endpoint, but filtered to include only the fields that match your search criteria.

***

## Search for Object Fields Endpoint

Want to try the API out? Visit our [Swagger](https://app.go.kizen.com/api/docs/public/swagger#/custom-objects/custom_objects_fields_search_create) docs.

## POST /api/custom-objects/{object\_pk}/fields/search

> Search fields

```json
{"openapi":"3.0.3","info":{"title":"Kizen API","version":"1.0.0"},"security":[{"businessId":[],"userId":[],"apiKey":[]}],"components":{"securitySchemes":{"businessId":{"type":"apiKey","in":"header","name":"X-BUSINESS-ID"}},"schemas":{"CustomObjectDetailedFieldReadRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1},"category":{"type":"string","format":"uuid"},"display_name":{"type":"string","minLength":1},"canonical_display_name":{"type":"string","minLength":1},"is_default":{"type":"boolean"},"field_type":{"$ref":"#/components/schemas/FieldTypeEnum"},"is_required":{"type":"boolean"},"is_read_only":{"type":"boolean"},"is_hidden":{"type":"boolean"},"is_deletable":{"type":"boolean"},"is_hideable":{"type":"boolean"},"is_suppressed":{"type":"boolean"},"include_in_short_form":{"type":"string","minLength":1},"allows_nulls":{"type":"boolean"},"allows_empty":{"type":"boolean"},"order":{"type":"integer"},"meta":{"type":"object","additionalProperties":{}},"description":{"type":"string","minLength":1},"description_visibility":{"$ref":"#/components/schemas/DescriptionVisibilityEnum"},"properties":{"type":"object","additionalProperties":{}},"access":{"$ref":"#/components/schemas/AccessSerpyRequest"},"options":{"type":"array","items":{"$ref":"#/components/schemas/FieldOptionSerpyRequest"}},"relation":{"$ref":"#/components/schemas/CustomObjectFieldRelationRequest"},"allow_on_forms":{"type":"boolean"}},"required":["access","allow_on_forms","allows_empty","allows_nulls","canonical_display_name","category","description","description_visibility","display_name","field_type","id","include_in_short_form","is_default","is_deletable","is_hidden","is_hideable","is_read_only","is_required","is_suppressed","meta","name","options","order","properties","relation"]},"FieldTypeEnum":{"enum":["checkbox","checkboxes","choices","date","datetime","decimal","dropdown","dynamictags","email","files","integer","longtext","money","phonenumber","radio","rating","relationship","selector","status","team_selector","text","timezone","wysiwyg","yesnomaybe"],"type":"string","description":"* `checkbox` - Checkbox\n* `checkboxes` - Checkboxes\n* `choices` - Choices\n* `date` - Date\n* `datetime` - Datetime\n* `decimal` - Decimal Number\n* `dropdown` - Dropdown\n* `dynamictags` - Dynamic Tags\n* `email` - Email\n* `files` - Files\n* `integer` - Whole Number\n* `longtext` - Long Text\n* `money` - Money\n* `phonenumber` - Phone Number\n* `radio` - Radio\n* `rating` - Rating\n* `relationship` - Relationship\n* `selector` - Selector\n* `status` - Status\n* `team_selector` - Team Selector\n* `text` - Text\n* `timezone` - Timezone\n* `wysiwyg` - Wysiwyg\n* `yesnomaybe` - Yes / No / Maybe Question"},"DescriptionVisibilityEnum":{"enum":["all","create_only","settings_only"],"type":"string","description":"* `all` - All Labels\n* `create_only` - Only on Create\n* `settings_only` - Only in Settings"},"AccessSerpyRequest":{"type":"object","properties":{"view":{"type":"boolean"},"edit":{"type":"boolean"},"remove":{"type":"boolean"}},"required":["edit","remove","view"]},"FieldOptionSerpyRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"code":{"type":"string","minLength":1},"name":{"type":"string","minLength":1},"order":{"type":"integer"},"meta":{"type":"object","additionalProperties":{}},"percentage_chance_to_close":{"type":"integer"},"chance_to_close_percentage":{"type":"integer"},"status":{"$ref":"#/components/schemas/StatusEnum"}},"required":["chance_to_close_percentage","code","id","meta","name","order","percentage_chance_to_close","status"]},"StatusEnum":{"enum":["open","won","lost","disqualified"],"type":"string","description":"* `open` - open\n* `won` - won\n* `lost` - lost\n* `disqualified` - disqualified"},"CustomObjectFieldRelationRequest":{"type":"object","properties":{"related_object":{"type":"string","format":"uuid"},"related_category":{"type":"string","format":"uuid","nullable":true},"related_name":{"type":"string","nullable":true,"minLength":1},"relation_type":{"$ref":"#/components/schemas/CustomObjectFieldRelationRelationTypeEnum"},"rollup_timeline":{"type":"boolean"},"rollup_leadsources":{"type":"boolean"},"inverse_relation_rollup_timeline":{"type":"boolean"},"inverse_relation_rollup_leadsources":{"type":"boolean"},"inverse_relation_suppressed":{"type":"boolean"}},"required":["related_category","related_object"]},"CustomObjectFieldRelationRelationTypeEnum":{"enum":["one_to_one","primary","additional","primary_for","additional_for"],"type":"string","description":"* `one_to_one` - one to one\n* `primary` - primary\n* `additional` - additional\n* `primary_for` - primary for\n* `additional_for` - additional for"},"CustomObjectDetailedFieldRead":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"category":{"type":"string","format":"uuid"},"display_name":{"type":"string"},"canonical_display_name":{"type":"string"},"is_default":{"type":"boolean"},"field_type":{"$ref":"#/components/schemas/FieldTypeEnum"},"is_required":{"type":"boolean"},"is_read_only":{"type":"boolean"},"is_hidden":{"type":"boolean"},"is_deletable":{"type":"boolean"},"is_hideable":{"type":"boolean"},"is_suppressed":{"type":"boolean"},"include_in_short_form":{"type":"string"},"allows_nulls":{"type":"boolean"},"allows_empty":{"type":"boolean"},"order":{"type":"integer"},"meta":{"type":"object","additionalProperties":{}},"description":{"type":"string"},"description_visibility":{"$ref":"#/components/schemas/DescriptionVisibilityEnum"},"properties":{"type":"object","additionalProperties":{}},"access":{"$ref":"#/components/schemas/AccessSerpy"},"options":{"type":"array","items":{"$ref":"#/components/schemas/FieldOptionSerpy"}},"relation":{"$ref":"#/components/schemas/CustomObjectFieldRelation"},"allow_on_forms":{"type":"boolean"}},"required":["access","allow_on_forms","allows_empty","allows_nulls","canonical_display_name","category","description","description_visibility","display_name","field_type","id","include_in_short_form","is_default","is_deletable","is_hidden","is_hideable","is_read_only","is_required","is_suppressed","meta","name","options","order","properties","relation"]},"AccessSerpy":{"type":"object","properties":{"view":{"type":"boolean"},"edit":{"type":"boolean"},"remove":{"type":"boolean"}},"required":["edit","remove","view"]},"FieldOptionSerpy":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"code":{"type":"string"},"name":{"type":"string"},"order":{"type":"integer"},"meta":{"type":"object","additionalProperties":{}},"percentage_chance_to_close":{"type":"integer"},"chance_to_close_percentage":{"type":"integer"},"status":{"$ref":"#/components/schemas/StatusEnum"}},"required":["chance_to_close_percentage","code","id","meta","name","order","percentage_chance_to_close","status"]},"CustomObjectFieldRelation":{"type":"object","properties":{"related_field":{"type":"string","format":"uuid","readOnly":true},"related_object":{"type":"string","format":"uuid"},"related_category":{"type":"string","format":"uuid","nullable":true},"related_name":{"type":"string","nullable":true},"related_object_name":{"type":"string","readOnly":true},"related_object_object_name":{"type":"string","readOnly":true},"related_entity_name":{"type":"string","readOnly":true},"relation_type":{"$ref":"#/components/schemas/CustomObjectFieldRelationRelationTypeEnum"},"cardinality":{"allOf":[{"$ref":"#/components/schemas/CardinalityEnum"}],"readOnly":true},"fetch_url":{"type":"string","readOnly":true},"rollup_timeline":{"type":"boolean"},"rollup_leadsources":{"type":"boolean"},"inverse_relation_rollup_timeline":{"type":"boolean"},"inverse_relation_rollup_leadsources":{"type":"boolean"},"inverse_relation_suppressed":{"type":"boolean"},"related_object_default_on_activities":{"type":"string","readOnly":true}},"required":["cardinality","fetch_url","related_category","related_entity_name","related_field","related_object","related_object_default_on_activities","related_object_name","related_object_object_name"]},"CardinalityEnum":{"enum":["one_to_one","many_to_many","many_to_one","one_to_many"],"type":"string","description":"* `one_to_one` - 1 to 1\n* `many_to_many` - Many to Many\n* `many_to_one` - Many to 1\n* `one_to_many` - 1 to Many"}}},"paths":{"/api/custom-objects/{object_pk}/fields/search":{"post":{"operationId":"custom_objects_fields_search_create","description":"Search fields","parameters":[{"in":"query","name":"category","schema":{"type":"string","format":"uuid"}},{"in":"query","name":"field_type","schema":{"type":"string","enum":["checkbox","checkboxes","choices","date","datetime","decimal","dropdown","dynamictags","email","files","integer","longtext","money","phonenumber","radio","rating","relationship","selector","status","team_selector","text","timezone","wysiwyg","yesnomaybe"]},"description":"* `checkbox` - Checkbox\n* `checkboxes` - Checkboxes\n* `choices` - Choices\n* `date` - Date\n* `datetime` - Datetime\n* `decimal` - Decimal Number\n* `dropdown` - Dropdown\n* `dynamictags` - Dynamic Tags\n* `email` - Email\n* `files` - Files\n* `integer` - Whole Number\n* `longtext` - Long Text\n* `money` - Money\n* `phonenumber` - Phone Number\n* `radio` - Radio\n* `rating` - Rating\n* `relationship` - Relationship\n* `selector` - Selector\n* `status` - Status\n* `team_selector` - Team Selector\n* `text` - Text\n* `timezone` - Timezone\n* `wysiwyg` - Wysiwyg\n* `yesnomaybe` - Yes / No / Maybe Question"},{"in":"query","name":"field_type__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"is_default","schema":{"type":"boolean"}},{"in":"query","name":"numeric","schema":{"type":"boolean"}},{"in":"path","name":"object_pk","schema":{"type":"string"},"required":true},{"in":"query","name":"ordering","schema":{"type":"string","enum":["order"]},"description":"Which field to use when ordering the results. Prepend with '-' for descending order."},{"name":"search","required":false,"in":"query","description":"A search term.","schema":{"type":"string"}}],"tags":["custom-objects"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomObjectDetailedFieldReadRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CustomObjectDetailedFieldRead"}}}},"description":""}}}}}}
```

### Search for Object Fields Schema

## The CustomObjectDetailedFieldReadRequest object

```json
{"openapi":"3.0.3","info":{"title":"Kizen API","version":"1.0.0"},"components":{"schemas":{"CustomObjectDetailedFieldReadRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1},"category":{"type":"string","format":"uuid"},"display_name":{"type":"string","minLength":1},"canonical_display_name":{"type":"string","minLength":1},"is_default":{"type":"boolean"},"field_type":{"$ref":"#/components/schemas/FieldTypeEnum"},"is_required":{"type":"boolean"},"is_read_only":{"type":"boolean"},"is_hidden":{"type":"boolean"},"is_deletable":{"type":"boolean"},"is_hideable":{"type":"boolean"},"is_suppressed":{"type":"boolean"},"include_in_short_form":{"type":"string","minLength":1},"allows_nulls":{"type":"boolean"},"allows_empty":{"type":"boolean"},"order":{"type":"integer"},"meta":{"type":"object","additionalProperties":{}},"description":{"type":"string","minLength":1},"description_visibility":{"$ref":"#/components/schemas/DescriptionVisibilityEnum"},"properties":{"type":"object","additionalProperties":{}},"access":{"$ref":"#/components/schemas/AccessSerpyRequest"},"options":{"type":"array","items":{"$ref":"#/components/schemas/FieldOptionSerpyRequest"}},"relation":{"$ref":"#/components/schemas/CustomObjectFieldRelationRequest"},"allow_on_forms":{"type":"boolean"}},"required":["access","allow_on_forms","allows_empty","allows_nulls","canonical_display_name","category","description","description_visibility","display_name","field_type","id","include_in_short_form","is_default","is_deletable","is_hidden","is_hideable","is_read_only","is_required","is_suppressed","meta","name","options","order","properties","relation"]},"FieldTypeEnum":{"enum":["checkbox","checkboxes","choices","date","datetime","decimal","dropdown","dynamictags","email","files","integer","longtext","money","phonenumber","radio","rating","relationship","selector","status","team_selector","text","timezone","wysiwyg","yesnomaybe"],"type":"string","description":"* `checkbox` - Checkbox\n* `checkboxes` - Checkboxes\n* `choices` - Choices\n* `date` - Date\n* `datetime` - Datetime\n* `decimal` - Decimal Number\n* `dropdown` - Dropdown\n* `dynamictags` - Dynamic Tags\n* `email` - Email\n* `files` - Files\n* `integer` - Whole Number\n* `longtext` - Long Text\n* `money` - Money\n* `phonenumber` - Phone Number\n* `radio` - Radio\n* `rating` - Rating\n* `relationship` - Relationship\n* `selector` - Selector\n* `status` - Status\n* `team_selector` - Team Selector\n* `text` - Text\n* `timezone` - Timezone\n* `wysiwyg` - Wysiwyg\n* `yesnomaybe` - Yes / No / Maybe Question"},"DescriptionVisibilityEnum":{"enum":["all","create_only","settings_only"],"type":"string","description":"* `all` - All Labels\n* `create_only` - Only on Create\n* `settings_only` - Only in Settings"},"AccessSerpyRequest":{"type":"object","properties":{"view":{"type":"boolean"},"edit":{"type":"boolean"},"remove":{"type":"boolean"}},"required":["edit","remove","view"]},"FieldOptionSerpyRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"code":{"type":"string","minLength":1},"name":{"type":"string","minLength":1},"order":{"type":"integer"},"meta":{"type":"object","additionalProperties":{}},"percentage_chance_to_close":{"type":"integer"},"chance_to_close_percentage":{"type":"integer"},"status":{"$ref":"#/components/schemas/StatusEnum"}},"required":["chance_to_close_percentage","code","id","meta","name","order","percentage_chance_to_close","status"]},"StatusEnum":{"enum":["open","won","lost","disqualified"],"type":"string","description":"* `open` - open\n* `won` - won\n* `lost` - lost\n* `disqualified` - disqualified"},"CustomObjectFieldRelationRequest":{"type":"object","properties":{"related_object":{"type":"string","format":"uuid"},"related_category":{"type":"string","format":"uuid","nullable":true},"related_name":{"type":"string","nullable":true,"minLength":1},"relation_type":{"$ref":"#/components/schemas/CustomObjectFieldRelationRelationTypeEnum"},"rollup_timeline":{"type":"boolean"},"rollup_leadsources":{"type":"boolean"},"inverse_relation_rollup_timeline":{"type":"boolean"},"inverse_relation_rollup_leadsources":{"type":"boolean"},"inverse_relation_suppressed":{"type":"boolean"}},"required":["related_category","related_object"]},"CustomObjectFieldRelationRelationTypeEnum":{"enum":["one_to_one","primary","additional","primary_for","additional_for"],"type":"string","description":"* `one_to_one` - one to one\n* `primary` - primary\n* `additional` - additional\n* `primary_for` - primary for\n* `additional_for` - additional for"}}}}
```

## The CustomObjectDetailedFieldRead object

```json
{"openapi":"3.0.3","info":{"title":"Kizen API","version":"1.0.0"},"components":{"schemas":{"CustomObjectDetailedFieldRead":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"category":{"type":"string","format":"uuid"},"display_name":{"type":"string"},"canonical_display_name":{"type":"string"},"is_default":{"type":"boolean"},"field_type":{"$ref":"#/components/schemas/FieldTypeEnum"},"is_required":{"type":"boolean"},"is_read_only":{"type":"boolean"},"is_hidden":{"type":"boolean"},"is_deletable":{"type":"boolean"},"is_hideable":{"type":"boolean"},"is_suppressed":{"type":"boolean"},"include_in_short_form":{"type":"string"},"allows_nulls":{"type":"boolean"},"allows_empty":{"type":"boolean"},"order":{"type":"integer"},"meta":{"type":"object","additionalProperties":{}},"description":{"type":"string"},"description_visibility":{"$ref":"#/components/schemas/DescriptionVisibilityEnum"},"properties":{"type":"object","additionalProperties":{}},"access":{"$ref":"#/components/schemas/AccessSerpy"},"options":{"type":"array","items":{"$ref":"#/components/schemas/FieldOptionSerpy"}},"relation":{"$ref":"#/components/schemas/CustomObjectFieldRelation"},"allow_on_forms":{"type":"boolean"}},"required":["access","allow_on_forms","allows_empty","allows_nulls","canonical_display_name","category","description","description_visibility","display_name","field_type","id","include_in_short_form","is_default","is_deletable","is_hidden","is_hideable","is_read_only","is_required","is_suppressed","meta","name","options","order","properties","relation"]},"FieldTypeEnum":{"enum":["checkbox","checkboxes","choices","date","datetime","decimal","dropdown","dynamictags","email","files","integer","longtext","money","phonenumber","radio","rating","relationship","selector","status","team_selector","text","timezone","wysiwyg","yesnomaybe"],"type":"string","description":"* `checkbox` - Checkbox\n* `checkboxes` - Checkboxes\n* `choices` - Choices\n* `date` - Date\n* `datetime` - Datetime\n* `decimal` - Decimal Number\n* `dropdown` - Dropdown\n* `dynamictags` - Dynamic Tags\n* `email` - Email\n* `files` - Files\n* `integer` - Whole Number\n* `longtext` - Long Text\n* `money` - Money\n* `phonenumber` - Phone Number\n* `radio` - Radio\n* `rating` - Rating\n* `relationship` - Relationship\n* `selector` - Selector\n* `status` - Status\n* `team_selector` - Team Selector\n* `text` - Text\n* `timezone` - Timezone\n* `wysiwyg` - Wysiwyg\n* `yesnomaybe` - Yes / No / Maybe Question"},"DescriptionVisibilityEnum":{"enum":["all","create_only","settings_only"],"type":"string","description":"* `all` - All Labels\n* `create_only` - Only on Create\n* `settings_only` - Only in Settings"},"AccessSerpy":{"type":"object","properties":{"view":{"type":"boolean"},"edit":{"type":"boolean"},"remove":{"type":"boolean"}},"required":["edit","remove","view"]},"FieldOptionSerpy":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"code":{"type":"string"},"name":{"type":"string"},"order":{"type":"integer"},"meta":{"type":"object","additionalProperties":{}},"percentage_chance_to_close":{"type":"integer"},"chance_to_close_percentage":{"type":"integer"},"status":{"$ref":"#/components/schemas/StatusEnum"}},"required":["chance_to_close_percentage","code","id","meta","name","order","percentage_chance_to_close","status"]},"StatusEnum":{"enum":["open","won","lost","disqualified"],"type":"string","description":"* `open` - open\n* `won` - won\n* `lost` - lost\n* `disqualified` - disqualified"},"CustomObjectFieldRelation":{"type":"object","properties":{"related_field":{"type":"string","format":"uuid","readOnly":true},"related_object":{"type":"string","format":"uuid"},"related_category":{"type":"string","format":"uuid","nullable":true},"related_name":{"type":"string","nullable":true},"related_object_name":{"type":"string","readOnly":true},"related_object_object_name":{"type":"string","readOnly":true},"related_entity_name":{"type":"string","readOnly":true},"relation_type":{"$ref":"#/components/schemas/CustomObjectFieldRelationRelationTypeEnum"},"cardinality":{"allOf":[{"$ref":"#/components/schemas/CardinalityEnum"}],"readOnly":true},"fetch_url":{"type":"string","readOnly":true},"rollup_timeline":{"type":"boolean"},"rollup_leadsources":{"type":"boolean"},"inverse_relation_rollup_timeline":{"type":"boolean"},"inverse_relation_rollup_leadsources":{"type":"boolean"},"inverse_relation_suppressed":{"type":"boolean"},"related_object_default_on_activities":{"type":"string","readOnly":true}},"required":["cardinality","fetch_url","related_category","related_entity_name","related_field","related_object","related_object_default_on_activities","related_object_name","related_object_object_name"]},"CustomObjectFieldRelationRelationTypeEnum":{"enum":["one_to_one","primary","additional","primary_for","additional_for"],"type":"string","description":"* `one_to_one` - one to one\n* `primary` - primary\n* `additional` - additional\n* `primary_for` - primary for\n* `additional_for` - additional for"},"CardinalityEnum":{"enum":["one_to_one","many_to_many","many_to_one","one_to_many"],"type":"string","description":"* `one_to_one` - 1 to 1\n* `many_to_many` - Many to Many\n* `many_to_one` - Many to 1\n* `one_to_many` - 1 to Many"}}}}
```

***

## What's Next?

After retrieving field metadata with this API, you can:

* Retrieve full <code class="expression">space.vars.object</code> configuration (including categories and all fields) when you need broader schema context.
* Retrieve selectable field option values (for dropdowns, dynamic tags, radio buttons, and checkboxes) so your integration can validate allowed values.
* Use field IDs and names to safely read or write field values on records.
* Explore the <code class="expression">space.vars.fields</code> and schema metadata docs to understand field behaviors, constraints, and mapping best practices.

Continue learning about field types with the following resources:

<details>

<summary>Related Topics</summary>

* [Object APIs](/docs/concepts/objects/object-apis.md)
* [Object API Names](/docs/concepts/objects/object-apis/object-api-names.md)
* [Retrieve Object Details API](/docs/concepts/objects/object-apis/retrieve-object-details-by-id-api.md)
* [Retrieve Object Field Options API](/docs/concepts/objects/custom-fields/custom-field-apis/retrieve-object-field-options-api.md)

</details>

***


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developer.kizen.com/docs/concepts/objects/custom-fields/custom-field-apis/search-object-fields-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
