> ## Documentation Index > Fetch the complete documentation index at: https://help.hoopai.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Object Schema by key / id > Retrieve Object Schema by key or ID. This will return the schema of the custom object, including all its fields and properties. Supported objects include contact, opportunity, business and custom objects.To understand objects and records, please have a look the documentation here : https://help.hoopai.com/api-reference/overview/objects ## OpenAPI ````yaml /api-reference/objects/openapi.json get /objects/{key} openapi: 3.0.0 info: title: CUSTOM_OBJECTS API description: >- Custom objects are completely customizable objects that allow you to store and manage information tailored to your unique business needs. With custom objects, you can create custom fields, establish relationships, and integrate them into workflows, providing flexibility beyond standard objects like Contacts, Opportunities or Companies. version: '1.0' contact: {} servers: - url: https://services.leadconnectorhq.com security: [] tags: - name: Custom Objects Schema description: >- Custom objects are completely customizable objects that allow you to store and manage information tailored to your unique business needs. With custom objects, you can create custom fields, establish relationships, and integrate them into workflows, providing flexibility beyond standard objects like Contacts, Opportunities or Companies. - name: Object Schema description: >- Custom objects are completely customizable objects that allow you to store and manage information tailored to your unique business needs. With custom objects, you can create custom fields, establish relationships, and integrate them into workflows, providing flexibility beyond standard objects like Contacts, Opportunities or Companies. - name: Sub-Account (Formerly Location) description: >- Custom objects are completely customizable objects that allow you to store and manage information tailored to your unique business needs. With custom objects, you can create custom fields, establish relationships, and integrate them into workflows, providing flexibility beyond standard objects like Contacts, Opportunities or Companies. - name: Records description: >- Custom objects are completely customizable objects that allow you to store and manage information tailored to your unique business needs. With custom objects, you can create custom fields, establish relationships, and integrate them into workflows, providing flexibility beyond standard objects like Contacts, Opportunities or Companies. - name: Search Object Records description: >- Custom objects are completely customizable objects that allow you to store and manage information tailored to your unique business needs. With custom objects, you can create custom fields, establish relationships, and integrate them into workflows, providing flexibility beyond standard objects like Contacts, Opportunities or Companies. - name: Search description: >- Custom objects are completely customizable objects that allow you to store and manage information tailored to your unique business needs. With custom objects, you can create custom fields, establish relationships, and integrate them into workflows, providing flexibility beyond standard objects like Contacts, Opportunities or Companies. - name: Tags description: >- Custom objects are completely customizable objects that allow you to store and manage information tailored to your unique business needs. With custom objects, you can create custom fields, establish relationships, and integrate them into workflows, providing flexibility beyond standard objects like Contacts, Opportunities or Companies. - name: Tasks Search description: >- Custom objects are completely customizable objects that allow you to store and manage information tailored to your unique business needs. With custom objects, you can create custom fields, establish relationships, and integrate them into workflows, providing flexibility beyond standard objects like Contacts, Opportunities or Companies. - name: Custom Field description: >- Custom objects are completely customizable objects that allow you to store and manage information tailored to your unique business needs. With custom objects, you can create custom fields, establish relationships, and integrate them into workflows, providing flexibility beyond standard objects like Contacts, Opportunities or Companies. - name: Custom Value description: >- Custom objects are completely customizable objects that allow you to store and manage information tailored to your unique business needs. With custom objects, you can create custom fields, establish relationships, and integrate them into workflows, providing flexibility beyond standard objects like Contacts, Opportunities or Companies. - name: Timezone description: >- Custom objects are completely customizable objects that allow you to store and manage information tailored to your unique business needs. With custom objects, you can create custom fields, establish relationships, and integrate them into workflows, providing flexibility beyond standard objects like Contacts, Opportunities or Companies. - name: Template description: >- Custom objects are completely customizable objects that allow you to store and manage information tailored to your unique business needs. With custom objects, you can create custom fields, establish relationships, and integrate them into workflows, providing flexibility beyond standard objects like Contacts, Opportunities or Companies. - name: ElasticSearch description: >- Custom objects are completely customizable objects that allow you to store and manage information tailored to your unique business needs. With custom objects, you can create custom fields, establish relationships, and integrate them into workflows, providing flexibility beyond standard objects like Contacts, Opportunities or Companies. paths: /objects/{key}: get: tags: - Object Schema summary: Get Object Schema by key / id description: >- Retrieve Object Schema by key or ID. This will return the schema of the custom object, including all its fields and properties. Supported objects include contact, opportunity, business and custom objects.To understand objects and records, please have a look the documentation here : https://help.hoopai.com/api-reference/overview/objects operationId: get-object-schema-by-key parameters: - name: Version in: header description: API Version required: true schema: type: string enum: - '2021-07-28' - name: key required: true in: path description: >- key of the custom or standard object. For custom objects, the key must include the prefix “custom_objects.”. This key can be found on the Object Details page under Settings in the UI. schema: example: custom_objects.pet type: string - name: locationId required: true in: query description: location id of the sub account schema: example: 632c34b4c9b7da3358ac9891 type: string - name: fetchProperties required: false in: query description: >- Fetch Properties , Fetches all the standard / custom fields of the object when set to true schema: example: true type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/CustomObjectByIdResponseDTO' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/BadRequestDTO' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedDTO' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/UnprocessableDTO' security: - bearer: - objects/schema.readonly externalDocs: url: https://help.hoopai.com/api-reference/overview/objects description: >- To understand objects and records, please have a look the documentation. components: schemas: CustomObjectByIdResponseDTO: type: object properties: object: $ref: '#/components/schemas/ICustomObjectSchema' cache: type: boolean description: Is the response served from cache example: true fields: type: array items: $ref: '#/components/schemas/ICustomField' required: - cache BadRequestDTO: type: object properties: statusCode: type: number example: 400 message: type: string example: Bad Request required: - statusCode - message UnauthorizedDTO: type: object properties: statusCode: type: number example: 401 message: type: string example: 'Invalid token: access token is invalid' error: type: string example: Unauthorized required: - statusCode - message - error UnprocessableDTO: type: object properties: statusCode: type: number example: 422 message: type: array items: type: string example: - Unprocessable Entity error: type: string example: Unprocessable Entity required: - statusCode - message - error ICustomObjectSchema: type: object properties: id: type: string example: 661c06b4ffde146bdb469442 description: id of the custom / standard object schema standard: type: boolean example: false description: >- false in case of custom objects and true in case of standard objects like contacts and opportunities key: type: string example: custom_objects.pet description: >- key that would be used to refer the custom / standard Object internally (lowercase + underscore_separated). For custom objects, 'custom_objects.' would be added as prefix by default labels: $ref: '#/components/schemas/CustomObjectLabelDto' example: singular: Pet plural: Pets description: type: string example: These are non vaccinated pets description: >- Custom / Standard Object Descriptions for example , Pet Object`s description locationId: type: string description: location's id example: Q9DT3OAqEXDLYuob1G32 primaryDisplayProperty: type: string description: >- Primary property for the custom / standard Object. This would be used as primary data when rendering the UI. 'custom_objects.{{object_key}} or business.{{object_key}} (for company)' would be added as prefix by default for all the custom / standard objects example: custom_objects.pet.name dateAdded: type: string description: Date and time when the object was added format: date-time dateUpdated: type: string description: Date and time when the object was last updated format: date-time type: type: object example: The Object type can either USER_DEFINED or SYSTEM_DEFINED description: Object`s Type required: - id - standard - key - labels - locationId - primaryDisplayProperty - dateAdded - dateUpdated ICustomField: type: object properties: locationId: type: string description: Location Id example: ve9EPM428h8vShlRW1KT name: type: string description: Field name example: Name description: type: string description: Description of the field placeholder: type: string description: Placeholder text for the field showInForms: type: boolean description: Whether the field should be shown in forms options: description: >- Options for the field (Optional, valid only for SINGLE_OPTIONS, MULTIPLE_OPTIONS, RADIO, CHECKBOX, TEXTBOX_LIST type) type: array items: $ref: '#/components/schemas/OptionDTO' acceptedFormats: type: string enum: - .pdf - .docx - .doc - .jpg - .jpeg - .png - .gif - .csv - .xlsx - .xls - all description: >- Allowed file formats for uploads. Options include: .pdf, .docx, .doc, .jpg, .jpeg, .png, .gif, .csv, .xlsx, .xls, all id: type: string description: Unique identifier of the object objectKey: type: string description: >- The key for your custom / standard object. This key uniquely identifies the custom object. Example: "custom_object.pet" for a custom object related to pets. example: custom_object.pet dataType: type: string enum: - TEXT - LARGE_TEXT - NUMERICAL - PHONE - MONETORY - CHECKBOX - SINGLE_OPTIONS - MULTIPLE_OPTIONS - DATE - TEXTBOX_LIST - FILE_UPLOAD - RADIO description: Type of field that you are trying to create parentId: type: string description: ID of the parent folder example: 3v34PM428h8vShlRW1KT fieldKey: type: string description: >- Field key. For Custom Object it's formatted as "custom_object.{objectKey}.{fieldKey}". "custom_object" is a fixed prefix, "{objectKey}" is your custom object's identifier, and "{fieldName}" is the unique field name within that object. Example: "custom_object.pet.name" for a "name" field in a "pet" custom object. example: custom_object.pet.name allowCustomOption: type: boolean description: >- Determines if users can add a custom option value different from the predefined options in records for RADIO type fields. A custom value added in one record does not automatically become an option and will not appear as an option for other records. example: true maxFileLimit: type: number description: Maximum file limit for uploads example: 2 dateAdded: type: string description: Date and time when the object was added format: date-time dateUpdated: type: string description: Date and time when the object was last updated format: date-time required: - locationId - showInForms - id - objectKey - dataType - parentId - fieldKey - dateAdded - dateUpdated CustomObjectLabelDto: type: object properties: singular: type: string example: Pet description: Singular name of the custom object plural: type: string example: Pets description: Plural name of the custom object required: - singular - plural OptionDTO: type: object properties: key: type: string description: >- Key of the option (Included in Create and Response, excluded in Update) label: type: string description: Value of the option url: type: string description: URL associated with the option (Optional, valid only for RADIO type) required: - key - label securitySchemes: bearer: scheme: bearer bearerFormat: JWT description: >- Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account. type: http ````