Marketo API

Getting access, Developing, Testing

Back to Marketo

Get Named Account Field by Name

Retrieves metadata for single named account field. Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field

Input

type: object properties: parameters: type: object properties: fieldApiName: type: string description: The API name of named account field required: - fieldApiName title: Parameters

Output

required: - errors - requestId - result - success - warnings type: object properties: errors: type: array description: Array of errors that occurred if the request was unsuccessful items: required: - code - message type: object properties: code: type: string description: >- Error code of the error. See full list of error codes <a href="https://developers.marketo.com/rest-api/error-codes/">here</a> message: type: string description: Message describing the cause of the error moreResult: type: boolean description: Boolean indicating if there are more results in subsequent pages example: false nextPageToken: type: string description: Paging token given if the result set exceeded the allowed batch size requestId: type: string description: Id of the request made result: type: array description: Array of results for individual records in the operation, may be empty items: required: - dataType - description - displayName - isApiCreated - isCustom - isHidden - isHtmlEncodingInEmail - isSensitive - name type: object description: Lead field record properties: displayName: type: string description: UI display-name of the field name: type: string description: API name of the field description: type: string description: Description of the field dataType: type: string description: Datatype of the field length: type: integer description: >- Max length of the field. Only applicable to text, string, and text area. format: int32 isHidden: type: boolean description: If set to true, the field is hidden example: false isHtmlEncodingInEmail: type: boolean description: If set to true, field is encoded as HTML in email example: false isSensitive: type: boolean description: If set to true, field is marked as sensitive example: false isCustom: type: boolean description: If set to true, field is custom example: false isApiCreated: type: boolean description: If set to true, field was created using REST API example: false success: type: boolean description: Whether the request succeeded example: false warnings: type: array description: Array of warnings given for the operation items: required: - code - message type: object properties: code: type: integer description: Integer code of the warning format: int32 message: type: string description: Message describing the warning