Get Lead Fields

GET /rest/v1/leads/schema/fields.json

Retrieves metadata for all lead fields in the target instance.

Operation ID: getLeadFieldsUsingGET
Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field
Request format: application/json
Returns: ResponseOfLeadField

Parameters

Query 2

batchSize integer (int32)

The batch size to return. The max and default value is 300.

nextPageToken string

A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter. See Paging Tokens for more info.

Responses

200 OK ResponseOfLeadField

errors array of Error required

Array of errors that occurred if the request was unsuccessful

Model Error

code string required

Error code of the error. See full list of error codes here

message string required

Message describing the cause of the error

moreResult boolean

Boolean indicating if there are more results in subsequent pages

nextPageToken string

Paging token given if the result set exceeded the allowed batch size

requestId string required

Id of the request made

result array of LeadField required

Array of results for individual records in the operation, may be empty

Model LeadField

displayName string required

UI display-name of the field

name string required

API name of the field

description string required

Description of the field

dataType string required

Datatype of the field

length integer (int32)

Max length of the field. Only applicable to text, string, and text area.

isHidden boolean required

If set to true, the field is hidden

isHtmlEncodingInEmail boolean required

If set to true, field is encoded as HTML in email

isSensitive boolean required

If set to true, field is marked as sensitive

isCustom boolean required

If set to true, field is custom

isApiCreated boolean required

If set to true, field was created using REST API

success boolean required

Whether the request succeeded

warnings array of Warning required

Array of warnings given for the operation

Model Warning

code integer (int32) required

Integer code of the warning

message string required

Message describing the warning

Generated example

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "moreResult": false,
  "nextPageToken": "example-token",
  "requestId": "123",
  "result": [
    {
      "displayName": "Example name",
      "name": "Example name",
      "description": "string",
      "dataType": "string",
      "length": 123,
      "isHidden": false,
      "isHtmlEncodingInEmail": false,
      "isSensitive": false,
      "isCustom": false,
      "isApiCreated": false
    }
  ],
  "success": false,
  "warnings": [
    {
      "code": 123,
      "message": "string"
    }
  ]
}

Referenced models

Generated from swagger-mapi.json. Generated examples are inferred from the schema; they are illustrative and may not be valid production payloads.