Describe Lead

GET /rest/v1/leads/describe.json

Returns metadata about lead objects in the target instance, including a list of all fields available for interaction via the APIs.

Note: This endpoint has been superseded. Use Describe Lead2 endpoint instead.

Operation ID: describeUsingGET_2
Permissions: Read-Only Lead, Read-Write Lead
Request format: application/json
Returns: ResponseOfLeadAttribute

Responses

200 OK ResponseOfLeadAttribute

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 LeadAttribute required

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

Model LeadAttribute

dataType string required

Datatype of the field

displayName string required

UI display-name of the field

id integer (int32) required

Unique integer id of the field

length integer (int32)

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

rest LeadMapAttribute

Description of REST API usage attributes

Model LeadMapAttribute

name string required

Name of the attribute

readOnly boolean

Whether the attribute is read only

soap LeadMapAttribute

Description of SOAP API usage attributes

Model LeadMapAttribute

name string required

Name of the attribute

readOnly boolean

Whether the attribute is read only

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": [
    {
      "dataType": "string",
      "displayName": "Example name",
      "id": 123,
      "length": 123,
      "rest": {
        "name": "Example name",
        "readOnly": false
      },
      "soap": {
        "name": "Example name",
        "readOnly": 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.