Tooling API Examples
To retrieve information about fields created with Custom Address Fields, such as the
developer name, use Tooling API.
Get Information About a Custom Address Field on a Record
This example uses the CustomField REST HTTP
GET method to retrieve information about the Mailing_Address__c custom address field, with
the CustomField ID 00NXXXXXXXXXXXXXXX.
- HTTP GET example to retrieve information about a custom address field on a record
-
curl https://MyDomainName.my.salesforce.com/services/data/64.0/tooling/sobjects/CustomField/00NXXXXXXXXXXXXXXX -H "Authorization: Bearer token
- Example response
-
{ "attributes": { "type": "CustomField", "url": "https://MyDomainName.my.salesforce.com/services/dataa64.0/tooling/sobjects/CustomField/00NXXXXXXXXXXXXXXX" }, "Id": "00NXXXXXXXXXXXXXXX", "TableEnumOrId": "Account", "DeveloperName": "caf", "Description": null, "Length": null, "Precision": 18, "Scale": 15, "RelationshipLabel": null, "SummaryOperation": null, "InlineHelpText": null, "MaskType": null, "MaskChar": null, "NamespacePrefix": null, "ManageableState": "unmanaged", "CreatedDate": "2021-04-07T06:57:22.000+0000", "CreatedById": "005XXXXXXXXXXXXXXX", "LastModifiedDate": "2021-04-07T06:57:22.000+0000", "LastModifiedById": "005XXXXXXXXXXXXXXX", "EntityDefinitionId": "Account", "Metadata": { "businessOwnerGroup": null, "businessOwnerUser": null, "businessStatus": null, "caseSensitive": null, "complianceGroup": null, "customDataType": null, "defaultValue": null, "deleteConstraint": null, "deprecated": null, "description": null, "displayFormat": null, "displayLocationInDecimal": null, "encryptionScheme": null, "escapeMarkup": null, "externalDeveloperName": null, "externalId": false, "formula": null, "formulaTreatBlanksAs": null, "inlineHelpText": null, "isAIPredictionField": null, "isConvertLeadDisabled": null, "isFilteringDisabled": null, "isNameField": null, "isSortingDisabled": null, "label": "caf", "length": null, "lookupFilter": null, "maskChar": null, "maskType": null, "metadataRelationshipControllingField": null, "mktDataLakeFieldAttributes": null, "mktDataModelFieldAttributes": null, "populateExistingRows": null, "precision": null, "readOnlyProxy": null, "referenceTargetField": null, "referenceTo": null, "relationshipLabel": null, "relationshipName": null, "relationshipOrder": null, "reparentableMasterDetail": null, "required": null, "restrictedAdminField": null, "scale": null, "securityClassification": null, "startingNumber": null, "stripMarkup": null, "summarizedField": null, "summaryFilterItems": null, "summaryForeignKey": null, "summaryOperation": null, "trackFeedHistory": false, "trackHistory": null, "trackTrending": null, "translateData": null, "type": "Address", "unique": null, "urls": null, "valueSet": null, "visibleLines": null, "writeRequiresMasterRead": null }, "FullName": "Account.caf__c" }
Query Information About a Custom Address Field on a Record
This example uses the CustomField REST HTTP
Query method to retrieve the developer name of the Mailing_Address__c custom address field
with CustomField ID 00NXXXXXXXXXXXXXXX.
- Example query to retrieve the DeveloperName for a custom address field
-
Select+id,DeveloperName+from+CustomField+where+Id='00NXXXXXXXXXXXXXXX'
- HTTP Query example to retrieve information using the query
-
curl https://MyDomainName.my.salesforce.com/services/data/64.0/tooling/query?q=Select+id,DeveloperName+from+CustomField+where+Id='00NXXXXXXXXXXXXXXX -H "Authorization: Bearer token"
- Example response
-
{ "size": 1, "totalSize": 1, "done": true, "queryLocator": null, "entityTypeName": "CustomField", "records": [ { "attributes": { "type": "CustomField", "url": "/services/data/v54.0/tooling/sobjects/CustomField/00NXXXXXXXXXXXXXXX" }, "Id": "00NXXXXXXXXXXXXXXX", "DeveloperName": "Mailing_Address" } ] }