# Retrieve Object Details by ID API {% hint style="success" %} **Audience:** Developers and Solution Architects **Purpose:** Explains how to retrieve the full definition of a specific space.vars.object by ID so developers can understand its schema, fields, and configuration for use in integrations and workflows. {% endhint %} ## Overview Use the **Retrieve Object Details by ID** endpoint to fetch the complete schema definition for a single space.vars.object in your Business. This includes space.vars.object-level metadata as well as detailed configuration such as fields, categories, and relationship settings. This endpoint is designed for schema inspection and integration setup use cases, where an external system needs to understand how a specific space.vars.object is structured before interacting with its space.vars.entities. The material on this page builds on information covered in the [Objects Core Concepts](/docs/concepts/objects/object-core-concepts.md) and [Object Data Model](/docs/concepts/objects/object-data-model.md). {% hint style="info" %} **Note:** This endpoint returns detailed configuration for one space.vars.object only. To retrieve a list of available Custom Objects and their identifiers, use the **List Objects** endpoint. {% endhint %} ### Why Would I Use This API? You can use the Retrieve space.vars.object Details by ID API when you need to: * Inspect the full schema of an space.vars.object before querying or writing space.vars.entities * Retrieve field definitions and identifiers required for space.vars.entity-level APIs * Understand space.vars.object configuration, such as categories or relationship capabilities * Validate space.vars.object structure during integration setup or initialization * Build schema-aware integrations that adapt to different space.vars.object configurations ### Retrieve Object Details API behavior Use this endpoint to retrieve the full definition of a space.vars.object by providing its identifier. It: * Returns the full schema definition for a single space.vars.object * Requires a valid space.vars.object ID * Includes space.vars.object metadata, field definitions, and relationship configuration * Returns schema-level data only; no space.vars.entity data is included * Fails if the specified space.vars.object ID does not exist or is inaccessible *** ## Retrieve Object Details Endpoint Want to try the API out? Visit our [Swagger](https://app.go.kizen.com/api/docs/public/swagger#/custom-objects/custom_objects_detail_retrieve) docs. ## GET /api/custom-objects/{object\_pk}/detail > Custom object with fields and categories ```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":{"CustomObjectDetail":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"object_type":{"$ref":"#/components/schemas/ObjectTypeEnum"},"entity_name":{"type":"string","maxLength":200},"object_name":{"type":"string","maxLength":200},"has_commerce_data":{"type":"boolean","default":false},"default_on_activities":{"type":"boolean"},"owner":{"allOf":[{"$ref":"#/components/schemas/SerializerMeta"}],"readOnly":true},"name":{"type":"string"},"description":{"type":"string","nullable":true,"maxLength":500},"ai_description":{"type":"string","readOnly":true,"nullable":true},"is_custom":{"type":"boolean","readOnly":true},"fetch_url":{"type":"string","readOnly":true},"allow_relations":{"type":"boolean","readOnly":true},"meta":{"type":"object","additionalProperties":{}},"related_objects":{"type":"array","items":{"$ref":"#/components/schemas/CustomObjectRelatedObjects"}},"created":{"type":"string","format":"date-time","readOnly":true},"access":{"allOf":[{"$ref":"#/components/schemas/AccessSerpy"}],"readOnly":true},"entity_access":{"type":"boolean","readOnly":true},"rollup_related_leadsources":{"type":"boolean","nullable":true},"quick_filtering_enabled":{"type":"boolean","nullable":true},"record_layouts":{"type":"array","items":{"$ref":"#/components/schemas/EmbeddedRecordLayout"},"readOnly":true},"association_source":{"$ref":"#/components/schemas/AssociationSourceEnum"},"association_source_fields":{"type":"array","items":{"$ref":"#/components/schemas/AssociationSourceField"},"nullable":true},"field_categories":{"type":"array","items":{"$ref":"#/components/schemas/FieldCategory"},"readOnly":true},"fields":{"type":"array","items":{"$ref":"#/components/schemas/CustomObjectDetailedFieldRead"},"readOnly":true},"pipeline":{"allOf":[{"$ref":"#/components/schemas/CustomObjectPipeline"}],"readOnly":true},"browser_js_actions":{"type":"array","items":{"$ref":"#/components/schemas/BrowserJSAction"},"readOnly":true},"browser_route_scripts":{"type":"array","items":{"$ref":"#/components/schemas/BrowserRouteScript"},"readOnly":true},"custom_actions":{"type":"array","items":{"$ref":"#/components/schemas/CustomActionRead"},"readOnly":true}},"required":["access","ai_description","allow_relations","browser_js_actions","browser_route_scripts","created","custom_actions","default_on_activities","entity_access","entity_name","fetch_url","field_categories","fields","id","is_custom","object_name","owner","pipeline","record_layouts"]},"ObjectTypeEnum":{"enum":["pipeline","standard"],"type":"string","description":"* `pipeline` - pipeline\n* `standard` - standard"},"SerializerMeta":{"type":"object","properties":{"picture_url":{"type":"string"},"id":{"type":"string","format":"uuid"},"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string","format":"email"},"display_name":{"type":"string"},"account_type":{"type":"string"}},"required":["account_type","display_name","email","first_name","id","last_name","picture_url"]},"CustomObjectRelatedObjects":{"type":"object","properties":{"related_object":{"type":"string","format":"uuid"},"relation_type":{"$ref":"#/components/schemas/CustomObjectRelatedObjectsRelationTypeEnum"},"rollup_timeline":{"type":"boolean","default":false},"rollup_leadsources":{"type":"boolean","default":true},"object_type":{"type":"string","readOnly":true},"object_name":{"type":"string","readOnly":true},"entity_name":{"type":"string","readOnly":true},"field_id":{"type":"string","format":"uuid","nullable":true}},"required":["entity_name","object_name","object_type","related_object","relation_type"]},"CustomObjectRelatedObjectsRelationTypeEnum":{"enum":["one_to_one","primary","additional"],"type":"string","description":"* `one_to_one` - one to one\n* `primary` - primary\n* `additional` - additional"},"AccessSerpy":{"type":"object","properties":{"view":{"type":"boolean"},"edit":{"type":"boolean"},"remove":{"type":"boolean"}},"required":["edit","remove","view"]},"EmbeddedRecordLayout":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"name":{"type":"string"},"config":{"type":"object","additionalProperties":{}},"tabs":{"type":"object","additionalProperties":{}},"order":{"type":"number","format":"double"}},"required":["id","name"]},"AssociationSourceEnum":{"enum":["direct","related","direct_and_related"],"type":"string","description":"* `direct` - Direct\n* `related` - Related\n* `direct_and_related` - Direct and Related"},"AssociationSourceField":{"type":"object","description":"A serializer that accepts either an 'id' field or an alternate identifier field.\n\nThis serializer class automatically detects which identifier field is being used and\nperforms validation to ensure at least one identifier is provided. It also provides\nutility methods for retrieving objects by their identifiers.\n\nAttributes:\n IDENTIFIER_FIELD (str): The name of the alternate identifier field. Should be\n defined in subclasses.\n\nMethods:\n get_identifier_field(): Determines the alternate identifier field name.\n validate(attrs): Ensures either 'id' or the alternate identifier is provided.\n get_identifier_values(data, values_map, queryset): Retrieves objects by their identifiers.","properties":{"id":{"type":"string","format":"uuid","nullable":true,"description":"Required if \"name\" is not provided."},"name":{"type":"string","nullable":true,"description":"Required if \"id\" is not provided."},"related_field":{"type":"string","readOnly":true},"related_object":{"type":"string","readOnly":true}},"required":["related_field","related_object"]},"FieldCategory":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"order":{"type":"integer"}},"required":["id","name","order"]},"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"},"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"},"CustomObjectPipeline":{"type":"object","properties":{"stages":{"type":"array","items":{"$ref":"#/components/schemas/PipelineStage"}},"track_entity_value":{"type":"boolean"},"include_percentage_to_close":{"type":"boolean"},"use_ai_to_update_percentage":{"type":"boolean"}},"required":["stages"]},"PipelineStage":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"status":{"$ref":"#/components/schemas/StatusEnum"},"percentage_chance_to_close":{"type":"integer","maximum":100,"minimum":0,"nullable":true},"order":{"type":"integer","maximum":32767,"minimum":0}},"required":["name","order","status"]},"BrowserJSAction":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"api_name":{"type":"string"},"name":{"type":"string"},"script":{"type":"string"},"plugin_app":{"$ref":"#/components/schemas/PluginAppLight"}},"required":["api_name","id","name","plugin_app","script"]},"PluginAppLight":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"api_name":{"type":"string"},"base_config":{"type":"object","additionalProperties":{}}},"required":["api_name","base_config","id"]},"BrowserRouteScript":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"api_name":{"type":"string"},"name":{"type":"string"},"routes":{"type":"object","additionalProperties":{}},"script":{"type":"string"},"blocking":{"type":"boolean"},"custom_object":{"$ref":"#/components/schemas/_CustomObject"},"plugin_app":{"$ref":"#/components/schemas/PluginAppLight"}},"required":["api_name","blocking","custom_object","id","name","plugin_app","routes","script"]},"_CustomObject":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"object_name":{"type":"string"}},"required":["id","name","object_name"]},"CustomActionRead":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string"},"action":{"type":"string"},"automation":{"$ref":"#/components/schemas/_CustomActionAutomation"},"order":{"type":"integer"}},"required":["action","automation","description","id","name","order"]},"_CustomActionAutomation":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"api_name":{"type":"string"},"name":{"type":"string"}},"required":["api_name","id","name"]}}},"paths":{"/api/custom-objects/{object_pk}/detail":{"get":{"operationId":"custom_objects_detail_retrieve","description":"Custom object with fields and categories","parameters":[{"in":"path","name":"object_pk","schema":{"type":"string","format":"uuid"},"required":true}],"tags":["custom-objects"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomObjectDetail"}}},"description":""}}}}}} ``` ### Retrieve Object Details by ID API Schemas ## The CustomObjectDetail object ```json {"openapi":"3.0.3","info":{"title":"Kizen API","version":"1.0.0"},"components":{"schemas":{"CustomObjectDetail":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"object_type":{"$ref":"#/components/schemas/ObjectTypeEnum"},"entity_name":{"type":"string","maxLength":200},"object_name":{"type":"string","maxLength":200},"has_commerce_data":{"type":"boolean","default":false},"default_on_activities":{"type":"boolean"},"owner":{"allOf":[{"$ref":"#/components/schemas/SerializerMeta"}],"readOnly":true},"name":{"type":"string"},"description":{"type":"string","nullable":true,"maxLength":500},"ai_description":{"type":"string","readOnly":true,"nullable":true},"is_custom":{"type":"boolean","readOnly":true},"fetch_url":{"type":"string","readOnly":true},"allow_relations":{"type":"boolean","readOnly":true},"meta":{"type":"object","additionalProperties":{}},"related_objects":{"type":"array","items":{"$ref":"#/components/schemas/CustomObjectRelatedObjects"}},"created":{"type":"string","format":"date-time","readOnly":true},"access":{"allOf":[{"$ref":"#/components/schemas/AccessSerpy"}],"readOnly":true},"entity_access":{"type":"boolean","readOnly":true},"rollup_related_leadsources":{"type":"boolean","nullable":true},"quick_filtering_enabled":{"type":"boolean","nullable":true},"record_layouts":{"type":"array","items":{"$ref":"#/components/schemas/EmbeddedRecordLayout"},"readOnly":true},"association_source":{"$ref":"#/components/schemas/AssociationSourceEnum"},"association_source_fields":{"type":"array","items":{"$ref":"#/components/schemas/AssociationSourceField"},"nullable":true},"field_categories":{"type":"array","items":{"$ref":"#/components/schemas/FieldCategory"},"readOnly":true},"fields":{"type":"array","items":{"$ref":"#/components/schemas/CustomObjectDetailedFieldRead"},"readOnly":true},"pipeline":{"allOf":[{"$ref":"#/components/schemas/CustomObjectPipeline"}],"readOnly":true},"browser_js_actions":{"type":"array","items":{"$ref":"#/components/schemas/BrowserJSAction"},"readOnly":true},"browser_route_scripts":{"type":"array","items":{"$ref":"#/components/schemas/BrowserRouteScript"},"readOnly":true},"custom_actions":{"type":"array","items":{"$ref":"#/components/schemas/CustomActionRead"},"readOnly":true}},"required":["access","ai_description","allow_relations","browser_js_actions","browser_route_scripts","created","custom_actions","default_on_activities","entity_access","entity_name","fetch_url","field_categories","fields","id","is_custom","object_name","owner","pipeline","record_layouts"]},"ObjectTypeEnum":{"enum":["pipeline","standard"],"type":"string","description":"* `pipeline` - pipeline\n* `standard` - standard"},"SerializerMeta":{"type":"object","properties":{"picture_url":{"type":"string"},"id":{"type":"string","format":"uuid"},"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string","format":"email"},"display_name":{"type":"string"},"account_type":{"type":"string"}},"required":["account_type","display_name","email","first_name","id","last_name","picture_url"]},"CustomObjectRelatedObjects":{"type":"object","properties":{"related_object":{"type":"string","format":"uuid"},"relation_type":{"$ref":"#/components/schemas/CustomObjectRelatedObjectsRelationTypeEnum"},"rollup_timeline":{"type":"boolean","default":false},"rollup_leadsources":{"type":"boolean","default":true},"object_type":{"type":"string","readOnly":true},"object_name":{"type":"string","readOnly":true},"entity_name":{"type":"string","readOnly":true},"field_id":{"type":"string","format":"uuid","nullable":true}},"required":["entity_name","object_name","object_type","related_object","relation_type"]},"CustomObjectRelatedObjectsRelationTypeEnum":{"enum":["one_to_one","primary","additional"],"type":"string","description":"* `one_to_one` - one to one\n* `primary` - primary\n* `additional` - additional"},"AccessSerpy":{"type":"object","properties":{"view":{"type":"boolean"},"edit":{"type":"boolean"},"remove":{"type":"boolean"}},"required":["edit","remove","view"]},"EmbeddedRecordLayout":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"name":{"type":"string"},"config":{"type":"object","additionalProperties":{}},"tabs":{"type":"object","additionalProperties":{}},"order":{"type":"number","format":"double"}},"required":["id","name"]},"AssociationSourceEnum":{"enum":["direct","related","direct_and_related"],"type":"string","description":"* `direct` - Direct\n* `related` - Related\n* `direct_and_related` - Direct and Related"},"AssociationSourceField":{"type":"object","description":"A serializer that accepts either an 'id' field or an alternate identifier field.\n\nThis serializer class automatically detects which identifier field is being used and\nperforms validation to ensure at least one identifier is provided. It also provides\nutility methods for retrieving objects by their identifiers.\n\nAttributes:\n IDENTIFIER_FIELD (str): The name of the alternate identifier field. Should be\n defined in subclasses.\n\nMethods:\n get_identifier_field(): Determines the alternate identifier field name.\n validate(attrs): Ensures either 'id' or the alternate identifier is provided.\n get_identifier_values(data, values_map, queryset): Retrieves objects by their identifiers.","properties":{"id":{"type":"string","format":"uuid","nullable":true,"description":"Required if \"name\" is not provided."},"name":{"type":"string","nullable":true,"description":"Required if \"id\" is not provided."},"related_field":{"type":"string","readOnly":true},"related_object":{"type":"string","readOnly":true}},"required":["related_field","related_object"]},"FieldCategory":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"order":{"type":"integer"}},"required":["id","name","order"]},"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"},"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"},"CustomObjectPipeline":{"type":"object","properties":{"stages":{"type":"array","items":{"$ref":"#/components/schemas/PipelineStage"}},"track_entity_value":{"type":"boolean"},"include_percentage_to_close":{"type":"boolean"},"use_ai_to_update_percentage":{"type":"boolean"}},"required":["stages"]},"PipelineStage":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"status":{"$ref":"#/components/schemas/StatusEnum"},"percentage_chance_to_close":{"type":"integer","maximum":100,"minimum":0,"nullable":true},"order":{"type":"integer","maximum":32767,"minimum":0}},"required":["name","order","status"]},"BrowserJSAction":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"api_name":{"type":"string"},"name":{"type":"string"},"script":{"type":"string"},"plugin_app":{"$ref":"#/components/schemas/PluginAppLight"}},"required":["api_name","id","name","plugin_app","script"]},"PluginAppLight":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"api_name":{"type":"string"},"base_config":{"type":"object","additionalProperties":{}}},"required":["api_name","base_config","id"]},"BrowserRouteScript":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"api_name":{"type":"string"},"name":{"type":"string"},"routes":{"type":"object","additionalProperties":{}},"script":{"type":"string"},"blocking":{"type":"boolean"},"custom_object":{"$ref":"#/components/schemas/_CustomObject"},"plugin_app":{"$ref":"#/components/schemas/PluginAppLight"}},"required":["api_name","blocking","custom_object","id","name","plugin_app","routes","script"]},"_CustomObject":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"object_name":{"type":"string"}},"required":["id","name","object_name"]},"CustomActionRead":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string"},"action":{"type":"string"},"automation":{"$ref":"#/components/schemas/_CustomActionAutomation"},"order":{"type":"integer"}},"required":["action","automation","description","id","name","order"]},"_CustomActionAutomation":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"api_name":{"type":"string"},"name":{"type":"string"}},"required":["api_name","id","name"]}}}} ``` ## The \_CustomObject object ```json {"openapi":"3.0.3","info":{"title":"Kizen API","version":"1.0.0"},"components":{"schemas":{"_CustomObject":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"object_name":{"type":"string"}},"required":["id","name","object_name"]}}}} ``` ## The AccessSerpy object ```json {"openapi":"3.0.3","info":{"title":"Kizen API","version":"1.0.0"},"components":{"schemas":{"AccessSerpy":{"type":"object","properties":{"view":{"type":"boolean"},"edit":{"type":"boolean"},"remove":{"type":"boolean"}},"required":["edit","remove","view"]}}}} ``` ## 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"}}}} ``` ## The FieldCategory object ```json {"openapi":"3.0.3","info":{"title":"Kizen API","version":"1.0.0"},"components":{"schemas":{"FieldCategory":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"order":{"type":"integer"}},"required":["id","name","order"]}}}} ``` ## The FieldOptionSerpy object ```json {"openapi":"3.0.3","info":{"title":"Kizen API","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The CustomObjectRelatedObjects object ```json {"openapi":"3.0.3","info":{"title":"Kizen API","version":"1.0.0"},"components":{"schemas":{"CustomObjectRelatedObjects":{"type":"object","properties":{"related_object":{"type":"string","format":"uuid"},"relation_type":{"$ref":"#/components/schemas/CustomObjectRelatedObjectsRelationTypeEnum"},"rollup_timeline":{"type":"boolean","default":false},"rollup_leadsources":{"type":"boolean","default":true},"object_type":{"type":"string","readOnly":true},"object_name":{"type":"string","readOnly":true},"entity_name":{"type":"string","readOnly":true},"field_id":{"type":"string","format":"uuid","nullable":true}},"required":["entity_name","object_name","object_type","related_object","relation_type"]},"CustomObjectRelatedObjectsRelationTypeEnum":{"enum":["one_to_one","primary","additional"],"type":"string","description":"* `one_to_one` - one to one\n* `primary` - primary\n* `additional` - additional"}}}} ``` ## The CustomObjectFieldRelation object ```json {"openapi":"3.0.3","info":{"title":"Kizen API","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The AssociationSourceField object ```json {"openapi":"3.0.3","info":{"title":"Kizen API","version":"1.0.0"},"components":{"schemas":{"AssociationSourceField":{"type":"object","description":"A serializer that accepts either an 'id' field or an alternate identifier field.\n\nThis serializer class automatically detects which identifier field is being used and\nperforms validation to ensure at least one identifier is provided. It also provides\nutility methods for retrieving objects by their identifiers.\n\nAttributes:\n IDENTIFIER_FIELD (str): The name of the alternate identifier field. Should be\n defined in subclasses.\n\nMethods:\n get_identifier_field(): Determines the alternate identifier field name.\n validate(attrs): Ensures either 'id' or the alternate identifier is provided.\n get_identifier_values(data, values_map, queryset): Retrieves objects by their identifiers.","properties":{"id":{"type":"string","format":"uuid","nullable":true,"description":"Required if \"name\" is not provided."},"name":{"type":"string","nullable":true,"description":"Required if \"id\" is not provided."},"related_field":{"type":"string","readOnly":true},"related_object":{"type":"string","readOnly":true}},"required":["related_field","related_object"]}}}} ``` ## The CustomObjectPipeline object ```json {"openapi":"3.0.3","info":{"title":"Kizen API","version":"1.0.0"},"components":{"schemas":{"CustomObjectPipeline":{"type":"object","properties":{"stages":{"type":"array","items":{"$ref":"#/components/schemas/PipelineStage"}},"track_entity_value":{"type":"boolean"},"include_percentage_to_close":{"type":"boolean"},"use_ai_to_update_percentage":{"type":"boolean"}},"required":["stages"]},"PipelineStage":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"status":{"$ref":"#/components/schemas/StatusEnum"},"percentage_chance_to_close":{"type":"integer","maximum":100,"minimum":0,"nullable":true},"order":{"type":"integer","maximum":32767,"minimum":0}},"required":["name","order","status"]},"StatusEnum":{"enum":["open","won","lost","disqualified"],"type":"string","description":"* `open` - open\n* `won` - won\n* `lost` - lost\n* `disqualified` - disqualified"}}}} ``` ## The PipelineStage object ```json {"openapi":"3.0.3","info":{"title":"Kizen API","version":"1.0.0"},"components":{"schemas":{"PipelineStage":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"status":{"$ref":"#/components/schemas/StatusEnum"},"percentage_chance_to_close":{"type":"integer","maximum":100,"minimum":0,"nullable":true},"order":{"type":"integer","maximum":32767,"minimum":0}},"required":["name","order","status"]},"StatusEnum":{"enum":["open","won","lost","disqualified"],"type":"string","description":"* `open` - open\n* `won` - won\n* `lost` - lost\n* `disqualified` - disqualified"}}}} ``` ## The EmbeddedRecordLayout object ```json {"openapi":"3.0.3","info":{"title":"Kizen API","version":"1.0.0"},"components":{"schemas":{"EmbeddedRecordLayout":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"name":{"type":"string"},"config":{"type":"object","additionalProperties":{}},"tabs":{"type":"object","additionalProperties":{}},"order":{"type":"number","format":"double"}},"required":["id","name"]}}}} ``` ## The CustomActionRead object ```json {"openapi":"3.0.3","info":{"title":"Kizen API","version":"1.0.0"},"components":{"schemas":{"CustomActionRead":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string"},"action":{"type":"string"},"automation":{"$ref":"#/components/schemas/_CustomActionAutomation"},"order":{"type":"integer"}},"required":["action","automation","description","id","name","order"]},"_CustomActionAutomation":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"api_name":{"type":"string"},"name":{"type":"string"}},"required":["api_name","id","name"]}}}} ``` *** ## What’s Next? After retrieving space.vars.object details by ID, you can: * Query, create, or update space.vars.entities for the object using space.vars.entities APIs * Reference field identifiers when constructing space.vars.entity payloads * Use space.vars.object and field metadata to build schema-aware integrations * Combine space.vars.object schemas with space.vars.automation configuration For more information on space.vars.objects, check out the following topics below:
Related Topics * [Object APIs](/docs/concepts/objects/object-apis.md) * [Object API Names](/docs/concepts/objects/object-apis/object-api-names.md) * [List and Search Objects API](/docs/concepts/objects/object-apis/list-and-search-objects-api.md) * [Retrieve Object Field Options API](/docs/concepts/objects/custom-fields/custom-field-apis/retrieve-object-field-options-api.md)
--- # 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/object-apis/retrieve-object-details-by-id-api.md?ask= ``` 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.