> ## 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 Published User Defined Field From Field Label > Return information about the given user defined field identified by the owner and the field label. Note that field labels are fuzzy. Leading and trailing spaces and punctuation are ignored. NsApiSlow threshold: 5000 ms. ## OpenAPI ````yaml /openapi/agent/openapi-v3-UserDefinedFieldInfoAgent.json post /api/v1/Agents/UserDefinedFieldInfo/GetPublishedUserDefinedFieldFromFieldLabel 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/GetPublishedUserDefinedFieldFromFieldLabel: post: tags: - UserDefinedFieldInfo_Agent summary: Get Published User Defined Field From Field Label description: "Return information about the given user defined field identified by the owner and the field label.\n\nNote that field labels are fuzzy. Leading and trailing spaces and punctuation are ignored.\r\nNsApiSlow threshold: 5000 ms." operationId: v1UserDefinedFieldInfoAgent_GetPublishedUserDefinedFieldFromFieldLabel 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.GetPublishedUserDefinedFieldFromFieldLabelRequest text/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserDefinedFieldInfoCarriers.GetPublishedUserDefinedFieldFromFieldLabelRequest application/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserDefinedFieldInfoCarriers.GetPublishedUserDefinedFieldFromFieldLabelRequest text/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserDefinedFieldInfoCarriers.GetPublishedUserDefinedFieldFromFieldLabelRequest application/x-www-form-urlencoded: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserDefinedFieldInfoCarriers.GetPublishedUserDefinedFieldFromFieldLabelRequest application/json-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserDefinedFieldInfoCarriers.GetPublishedUserDefinedFieldFromFieldLabelRequest application/merge-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserDefinedFieldInfoCarriers.GetPublishedUserDefinedFieldFromFieldLabelRequest description: FieldLabel, OwnerType required: true responses: '200': description: OK content: application/json: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.UserDefinedFieldInfo text/json: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.UserDefinedFieldInfo application/xml: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.UserDefinedFieldInfo text/xml: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.UserDefinedFieldInfo application/json-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.UserDefinedFieldInfo application/merge-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.UserDefinedFieldInfo security: - SuperOffice_Password: [] SuperId_Authentication: [] components: schemas: SuperOffice.WebApi.v1.Carriers.UserDefinedFieldInfoCarriers.GetPublishedUserDefinedFieldFromFieldLabelRequest: description: >- GetPublishedUserDefinedFieldFromFieldLabel: Return information about the given user defined field identified by the owner and the field label. Note that field labels are fuzzy. Leading and trailing spaces and punctuation are ignored. type: object properties: FieldLabel: type: string OwnerType: enum: - Invalid - Contact - Person - Project - Sale - Temp - Appointment - Document - None type: string SuperOffice.CRM.Services.UserDefinedFieldInfo: description: "Return information about the user defined fields. The information can be used to mirror the layout of the user-defined fields in the user interface.\r\n\r\nCarrier object for UserDefinedFieldInfo.\r\nServices for the UserDefinedFieldInfo Carrier is available from the UserDefinedFieldInfo Agent." type: object properties: UDefFieldId: format: int32 description: Primary key type: integer ColumnId: format: int32 description: The ID of the database column this field corresponds to type: integer FieldDefault: description: Optional default value for String fields type: string FieldHeight: format: int32 description: field height in pixels, 0 = 'enough' (from font) type: integer FieldLabel: description: The label (lead text) type: string FieldLeft: format: int32 description: X pixel coordinate of field type: integer FieldTop: format: int32 description: Y pixel coordinate of field type: integer FieldType: description: >- Field type: 0 = leadtext only, 1 = Edit, 2 = CheckBox, 3 = dropdown, 4 = listbox enum: - Number - ShortText - LongText - Date - UnlimitedDate - Checkbox - List - Decimal type: string FieldWidth: format: int32 description: field width in pixels, 0 = 'enough' (from font) type: integer FormatMask: description: >- Formatting mask, can be whatever the controls understand (currently nothing :-)) type: string HideLabel: description: Hide the label if 1 type: boolean IsIndexed: description: Is this field indexed? 0 if no, index no. if yes type: boolean LabelHeight: format: int32 description: label height in pixels, 0 = 'enough' (from font) type: integer LabelLeft: format: int32 description: X pixel coordinate of label type: integer LabelTop: format: int32 description: Y pixel coordinate of label type: integer LabelWidth: format: int32 description: label width in pixels, 0 = 'enough' (from font) type: integer LastVersionId: format: int32 description: >- UDefFieldId this field had in the previous version, 0 = field is new in this version type: integer ListTableId: format: int32 description: >- The table ID of the source table for lists: kTableAssoc, kTableContInt or whatever type: integer IsMandatory: description: 0 = no, 1 = yes (field must be filled out) type: boolean Type: description: >- ID of owning table (contact, person, project) - this is not the actual tableNumber, rather it's an enum enum: - Invalid - Contact - Person - Project - Sale - Temp - Appointment - Document - None type: string Page1LineNo: format: int32 description: >- Line no on View Page 1, used if MDO flags are OFF. 0 = this field is not visible on page 1 type: integer ProgId: description: >- Programmatic ID, for use by software that needs to find a particular field. Carried over like udefIdentity across generations. Use a Company.Product.Field format to avoid naming conflicts; the Company name SuperOffice is reserved. type: string IsReadOnly: description: 0 = read/write, 1 = readonly (don't combine with mandatory 8-) ) type: boolean ShortLabel: description: >- Short name to be used in Archive headings and on page 1. If blank, the fieldLabel will be used everywhere. type: string TabOrder: format: int32 description: Tab order value, sets the field processing sequence type: integer TextLength: format: int32 description: Length (in characters) of a text field, 0 for other types type: integer Tooltip: description: Optional tooltip text for this field type: string UdefIdentity: format: int32 description: Unique number used to track field identity across layout changes type: integer UDListDefinitionId: format: int32 description: List to use for populating dropdown or listbox type: integer Justification: description: Justification - 0 = default, left, right, center enum: - Default - Left - Center - Right type: string Version: format: int32 description: >- Definition version number; ALL fields get new version whenever layout is updated. type: integer TemplateVariableName: description: Template variable name type: string HasBeenPublished: description: Has the udef field been published? type: boolean MdoListName: description: >- MDO list name used to populate this list. Derived from UDListDefinitionId and ListTableId. (Read-only) type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Security.TableRight: description: "Wraps a table right together with an explanatory reason.\r\nCode can indicate why access is restricted." type: object properties: Mask: type: string Reason: type: string SuperOffice.CRM.Security.FieldProperty: description: >- Class holding properties like field length, field type about a field in the carrier. type: object properties: FieldRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldRight' FieldType: type: string FieldLength: format: int32 description: '' type: integer SuperOffice.CRM.Security.FieldRight: description: "Wraps the field right together with an explanatory reason.\r\nAlso adds logical operators to the field rights so that they can be easily combined." type: object properties: Mask: type: string Reason: type: string ```` ## Related topics - [SuperOffice.WebApi.Data.UserDefinedFieldInfo GetPublishedUserDefinedFieldFromFieldLabelRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.UserDefinedFieldInfo_GetPublishedUserDefinedFieldFromFieldLabelRequest.md) - [How to update a user-defined field using the web services API](/en/api/web-services/howto/custom-objects/rest-update-udef-field.md) - [NSUserDefinedFieldInfoAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSUserDefinedFieldInfoAgent.md) - [SuperOffice.WebApi.Agents.UserDefinedFieldInfoAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.UserDefinedFieldInfoAgent.md) - [SuperOffice.WebApi.Agents.IUserDefinedFieldInfoAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IUserDefinedFieldInfoAgent.md) - [Get User Defined Field From Field Label](/en/api/reference/restful/agent/userdefinedfieldinfo_agent/get-user-defined-field-from-field-label.md)