{"_id":"59d7edd1ec0acc00105866e8","project":"5588b8a2f6c18d0d005bba03","version":{"_id":"5588b8a2f6c18d0d005bba06","project":"5588b8a2f6c18d0d005bba03","__v":15,"createdAt":"2015-06-23T01:38:42.696Z","releaseDate":"2015-06-23T01:38:42.696Z","categories":["5588b8a3f6c18d0d005bba07","5588e9689cfea70d00371df3","5588f5921163180d00b64704","561598b121e9110d0078025a","5616f1c9d170d00d00189306","5616f5c3a410c90d00c6121e","561803dcf8c9632100ac7592","563667280441020d0000e9eb","5642570d9417b40d00c0fcd3","57bf5f02efe0050e00d50bd5","57f53fb368a53b2000e03f0f","57f55187440418170086325a","582e3afa72fd270f0006926d","5841faa973967b0f004b4a2b","58db348aa32c8419002433bb"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"57f53fb368a53b2000e03f0f","version":"5588b8a2f6c18d0d005bba06","project":"5588b8a2f6c18d0d005bba03","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-10-05T18:00:19.547Z","from_sync":false,"order":0,"slug":"api","title":"REST API"},"user":"5588b847f6c18d0d005bba01","__v":1,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-10-06T20:55:45.161Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n\t\"Account\": [\n    {\n      \"fieldName\": \"Id\",\n      \"fieldLabel\": \"Account ID\",\n      \"objectName\": \"Account\",\n      \"fieldValue\": \"\",\n      \"required\": false,\n      \"fieldType\": \"text\",\n      \"picklistValues\": [],\n      \"isDefault\": false,\n      \"createable\": false\n    },\n    {\n      \"fieldName\": \"IsDeleted\",\n      \"fieldLabel\": \"Deleted\",\n      \"objectName\": \"Account\",\n      \"fieldValue\": \"\",\n      \"required\": false,\n      \"fieldType\": \"checkbox\",\n      \"picklistValues\": [],\n      \"isDefault\": false,\n      \"createable\": false\n    },        \n    {\n      \"fieldName\": \"AccountSource\",\n      \"fieldLabel\": \"Account Source\",\n      \"objectName\": \"Account\",\n      \"fieldValue\": \"\",\n      \"required\": false,\n      \"fieldType\": \"picklist\",\n      \"picklistValues\": [\n      \t{\n        \t\"active\": true,\n          \"defaultValue\": false,\n          \"label\": \"--None--\",\n          \"validFor\": null,\n          \"value\": \"\"\n        },\n        {\n        \t\"active\": true,\n          \"defaultValue\": false,\n          \"label\": \"Web\",\n          \"validFor\": null,\n          \"value\": \"Web\"\n        }\n      ]\n    }\n\t]\n}","name":""}]},"examples":{"codes":[{"code":"curl --header \"X-API-Token: <your token>\" https://api.mixmax.com/v1/salesforce/syncedFields?fields=Account","language":"curl"}]},"method":"get","auth":"required","params":[{"_id":"59d7ce6f2b792f0010dc3a23","ref":"","in":"query","required":true,"desc":"A comma-separated list of salesforce objects from which to retrieve synced fields.","default":"","type":"string","name":"fields"}],"url":"/v1/salesforce/syncedFields"},"isReference":true,"order":95,"body":"Use this API to determine available fields, and information about their display types. \n\nThe response is set of key value pairs with the object name as the key, and an array of salesforce field details as the value. The contents of salesforce field details are formatted like this:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"fieldName\",\n    \"0-1\": \"String\",\n    \"0-2\": \"The internal name of the field used when creating or updating an object.\",\n    \"1-0\": \"fieldLabel\",\n    \"1-1\": \"String\",\n    \"1-2\": \"The human readable field name.\",\n    \"2-0\": \"objectName\",\n    \"2-1\": \"String\",\n    \"2-2\": \"The salesforce object type this field belongs to.\",\n    \"3-0\": \"fieldValue\",\n    \"3-1\": \"String\",\n    \"3-2\": \"The default value of the field.\",\n    \"4-0\": \"required\",\n    \"4-1\": \"Boolean\",\n    \"4-2\": \"True if the field is required to exist on this object.\",\n    \"5-0\": \"fieldType\",\n    \"5-1\": \"String\",\n    \"5-2\": \"The type of field this represents (text, date, checkbox, picklist, multipicklist, number)\",\n    \"6-0\": \"picklistValues\",\n    \"6-1\": \"Object[]\",\n    \"6-2\": \"A list of valid values for picklist and multipicklist fields.\"\n  },\n  \"cols\": 3,\n  \"rows\": 7\n}\n[/block]","excerpt":"Retrieve available Salesforce fields.","slug":"salesforcesyncedfields","type":"endpoint","title":"/salesforce/syncedFields"}

get/salesforce/syncedFields

Retrieve available Salesforce fields.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

fields:
required
string
A comma-separated list of salesforce objects from which to retrieve synced fields.

Examples


Result Format


Documentation

Use this API to determine available fields, and information about their display types. The response is set of key value pairs with the object name as the key, and an array of salesforce field details as the value. The contents of salesforce field details are formatted like this: [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Type", "h-2": "Description", "0-0": "fieldName", "0-1": "String", "0-2": "The internal name of the field used when creating or updating an object.", "1-0": "fieldLabel", "1-1": "String", "1-2": "The human readable field name.", "2-0": "objectName", "2-1": "String", "2-2": "The salesforce object type this field belongs to.", "3-0": "fieldValue", "3-1": "String", "3-2": "The default value of the field.", "4-0": "required", "4-1": "Boolean", "4-2": "True if the field is required to exist on this object.", "5-0": "fieldType", "5-1": "String", "5-2": "The type of field this represents (text, date, checkbox, picklist, multipicklist, number)", "6-0": "picklistValues", "6-1": "Object[]", "6-2": "A list of valid values for picklist and multipicklist fields." }, "cols": 3, "rows": 7 } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}