Get Company Field by Name¶

GET /rest/v1/companies/schema/fields/{fieldApiName}.json

Permissions Read-Write Schema Standard FieldRead-Write Schema Custom Field

Method: GET
Path: /rest/v1/companies/schema/fields/{fieldApiName}.json
Tag: Companies
Operation ID: getCompanyFieldByNameUsingGET

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

Formats¶

Request: application/json
Response: application/json

Request¶

Path parameters¶

Name	Type	Required	Description	Constraints
`fieldApiName`	string	Yes	The API name of company field

Example request¶

GET {{base_url}}/rest/v1/companies/schema/fields/{{fieldApiName}}.json
Accept: application/json

Responses¶

200 — OK¶

Schema: model: ResponseOfLeadField

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¶

ResponseOfLeadField

Source¶

Generated from swagger-mapi.json.

Generated examples are inferred from the schema. They are illustrative and may not be valid production payloads.