> ## Documentation Index > Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Custom Field Info > Return information about a particular custom field (user-defined + extra) on a particular table NsApiSlow threshold: 5000 ms. ## OpenAPI ````yaml /openapi/agent/openapi-v3-UserDefinedFieldInfoAgent.json post /api/v1/Agents/UserDefinedFieldInfo/GetCustomFieldInfo openapi: 3.0.0 info: version: v1-Agents title: SuperOffice Agent API v1 description: SuperOffice Agent API - UserDefinedFieldInfoAgent contact: name: SuperOffice DevNet url: https://docs.superoffice.com/en/api/index.html email: sdk@superoffice.com servers: - url: http://localhost:56350 - url: https://localhost:56350 security: [] tags: [] externalDocs: description: >- The SuperOffice DevNet Community has more documentation, examples, and discussion forums. url: https://community.superoffice.com/en/developer/ paths: /api/v1/Agents/UserDefinedFieldInfo/GetCustomFieldInfo: post: tags: - UserDefinedFieldInfo_Agent summary: Get Custom Field Info description: >- Return information about a particular custom field (user-defined + extra) on a particular table NsApiSlow threshold: 5000 ms. operationId: v1UserDefinedFieldInfoAgent_GetCustomFieldInfo parameters: - name: $select in: query description: >- Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields. required: false schema: type: string - name: Accept-Language in: header description: >- Convert string references and multi-language values into a specified language (iso2) code. required: false schema: type: string - name: SO-Language in: header description: >- Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value. required: false schema: type: string - name: SO-Culture in: header description: >- Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set. required: false schema: type: string - name: SO-TimeZone in: header description: >- Specify the timezone code that you would like date/time responses converted to. required: false schema: type: string - name: SO-AppToken in: header description: >- The application token that identifies the partner app. Used when calling Online WebAPI from a server. required: false schema: type: string requestBody: content: application/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserDefinedFieldInfoCarriers.GetCustomFieldInfoRequest text/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserDefinedFieldInfoCarriers.GetCustomFieldInfoRequest application/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserDefinedFieldInfoCarriers.GetCustomFieldInfoRequest text/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserDefinedFieldInfoCarriers.GetCustomFieldInfoRequest application/x-www-form-urlencoded: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserDefinedFieldInfoCarriers.GetCustomFieldInfoRequest application/json-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserDefinedFieldInfoCarriers.GetCustomFieldInfoRequest application/merge-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserDefinedFieldInfoCarriers.GetCustomFieldInfoRequest description: TableName, FieldName required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.FieldInfoBase' text/json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.FieldInfoBase' application/xml: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.FieldInfoBase' text/xml: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.FieldInfoBase' application/json-patch+json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.FieldInfoBase' application/merge-patch+json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.FieldInfoBase' security: - SuperOffice_Password: [] SuperId_Authentication: [] components: schemas: SuperOffice.WebApi.v1.Carriers.UserDefinedFieldInfoCarriers.GetCustomFieldInfoRequest: description: >- GetCustomFieldInfo: Return information about a particular custom field (user-defined + extra) on a particular table type: object properties: TableName: type: string FieldName: type: string SuperOffice.CRM.Services.FieldInfoBase: description: "Abstract basic information about database fields. May be custom or user-defined fields. The information can be used to build a user interface.\r\n\r\nCarrier object for FieldInfoBase.\r\nServices for the FieldInfoBase Carrier is available from the UserDefinedFieldInfo Agent." type: object properties: FieldType: description: >- What sort of data does this field contain. 1 = int, 2 = short text, ... enum: - Unknown - Integer - ShortText - LongText - Date - Blob - Checkbox - MdoList - Decimal - DateTime - Time - TimeSpan - RelationTo - Attachment - DynamicLink - ListText type: string FieldName: description: 'Database name or prog-id: ''x_foobar'' or ''SuperOffice:2''.' type: string DisplayName: description: Label for field. May be multi-lang string encoded. type: string Description: description: Optional tooltip text for this field type: string ShortLabel: description: >- Short name to be used in Archive headings and on page 1. If blank, the fieldLabel will be used everywhere. type: string HideLabel: description: Hide the label if 1 type: boolean HideField: description: Hide the field from the UI. Only allow API access. type: boolean IsIndexed: description: Is this field indexed? 0 if no, index no. if yes type: boolean IsMandatory: description: 0 = no, 1 = yes (field must be filled out) type: boolean IsReadOnly: description: 0 = read/write, 1 = readonly (don't combine with mandatory 8-) ) type: boolean IsExternal: description: Should this field be shown to external users via customer center? type: boolean IsDisplayField: description: >- Flag indicating that this field is chosen as DisplayField for a table it belongs type: boolean Rank: format: int32 description: Tab order, ranking within the custom fields. type: integer TemplateVariableName: description: 'Template variable name: ''cs01'', ''cl02'' etc. Null for extra fields.' type: string ```` ## Related topics - [Get Custom Field Info](/en/api/reference/restful/rest/fieldinfobase/get-custom-field-info.md)