Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
queryParams = Chilkat::CkJsonObject.new()
queryParams.UpdateString("q","SELECT FIELDS(All) FROM ACCOUNT ORDER BY Name LIMIT 5")
# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
http.SetRequestHeader("Content-Type","application/json")
# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://domain.com/services/data/v{{version}}/query/",queryParams)
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print resp.header() + "\n";
print "Failed." + "\n";
exit
end
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "totalSize": 5,
# "done": true,
# "records": [
# {
# "attributes": {
# "type": "Account",
# "url": "/services/data/v58.0/sobjects/Account/001B000000UnQ2wIAF"
# },
# "Id": "001B000000UnQ2wIAF",
# "IsDeleted": false,
# "MasterRecordId": null,
# "Name": "Burlington Textiles Corp of America",
# "Type": "Customer - Direct",
# "ParentId": null,
# "BillingStreet": "525 S. Lexington Ave",
# "BillingCity": "Burlington",
# "BillingState": "NC",
# "BillingPostalCode": "27215",
# "BillingCountry": "USA",
# "BillingLatitude": null,
# "BillingLongitude": null,
# "BillingGeocodeAccuracy": null,
# "BillingAddress": {
# "city": "Burlington",
# "country": "USA",
# "geocodeAccuracy": null,
# "latitude": null,
# "longitude": null,
# "postalCode": "27215",
# "state": "NC",
# "street": "525 S. Lexington Ave"
# },
# "ShippingStreet": null,
# "ShippingCity": null,
# "ShippingState": null,
# "ShippingPostalCode": null,
# "ShippingCountry": null,
# "ShippingLatitude": null,
# "ShippingLongitude": null,
# "ShippingGeocodeAccuracy": null,
# "ShippingAddress": null,
# "Phone": "(336) 222-7000",
# "Fax": "(336) 222-8000",
# "AccountNumber": "CD656092",
# "Website": "www.burlington.com",
# "PhotoUrl": "/services/images/photo/001B000000UnQ2wIAF",
# "Sic": "546732",
# "Industry": "Apparel",
# "AnnualRevenue": 350000000,
# "NumberOfEmployees": 9000,
# "Ownership": "Public",
# "TickerSymbol": "BTXT",
# "Description": null,
# "Rating": "Warm",
# "Site": null,
# "OwnerId": "005B0000003TOI6IAO",
# "CreatedDate": "2017-08-18T14:46:22.000+0000",
# "CreatedById": "005B0000003TOI6IAO",
# "LastModifiedDate": "2017-08-18T14:46:22.000+0000",
# "LastModifiedById": "005B0000003TOI6IAO",
# "SystemModstamp": "2017-08-18T14:46:22.000+0000",
# "LastActivityDate": null,
# "LastViewedDate": null,
# "LastReferencedDate": null,
# "IsPartner": false,
# "IsCustomerPortal": false,
# "ChannelProgramName": null,
# "ChannelProgramLevelName": null,
# "Jigsaw": null,
# "JigsawCompanyId": null,
# "CleanStatus": "Pending",
# "AccountSource": null,
# "DunsNumber": null,
# "Tradestyle": null,
# "NaicsCode": null,
# "NaicsDesc": null,
# "YearStarted": null,
# "SicDesc": null,
# "DandbCompanyId": null,
# "CustomerPriority__c": null,
# "SLA__c": "Silver",
# "Active__c": null,
# "NumberofLocations__c": 6,
# "UpsellOpportunity__c": "Maybe",
# "SLASerialNumber__c": "5367",
# "SLAExpirationDate__c": "2016-09-12"
# },
# {
# "attributes": {
# "type": "Account",
# "url": "/services/data/v58.0/sobjects/Account/001B000000UnQ2yIAF"
# },
# "Id": "001B000000UnQ2yIAF",
# "IsDeleted": false,
# "MasterRecordId": null,
# "Name": "Dickenson plc",
# "Type": "Customer - Channel",
# "ParentId": null,
# "BillingStreet": "1301 Hoch Drive",
# "BillingCity": "Lawrence",
# "BillingState": "KS",
# "BillingPostalCode": "66045",
# "BillingCountry": "USA",
# "BillingLatitude": null,
# "BillingLongitude": null,
# "BillingGeocodeAccuracy": null,
# "BillingAddress": {
# "city": "Lawrence",
# "country": "USA",
# "geocodeAccuracy": null,
# "latitude": null,
# "longitude": null,
# "postalCode": "66045",
# "state": "KS",
# "street": "1301 Hoch Drive"
# },
# "ShippingStreet": "1301 Hoch Drive",
# "ShippingCity": "Lawrence",
# "ShippingState": "KS",
# "ShippingPostalCode": "66045",
# "ShippingCountry": "USA",
# "ShippingLatitude": null,
# "ShippingLongitude": null,
# "ShippingGeocodeAccuracy": null,
# "ShippingAddress": {
# "city": "Lawrence",
# "country": "USA",
# "geocodeAccuracy": null,
# "latitude": null,
# "longitude": null,
# "postalCode": "66045",
# "state": "KS",
# "street": "1301 Hoch Drive"
# },
# "Phone": "(785) 241-6200",
# "Fax": "(785) 241-6201",
# "AccountNumber": "CC634267",
# "Website": "dickenson-consulting.com",
# "PhotoUrl": "/services/images/photo/001B000000UnQ2yIAF",
# "Sic": "6752",
# "Industry": "Consulting",
# "AnnualRevenue": 50000000,
# "NumberOfEmployees": 120,
# "Ownership": "Private",
# "TickerSymbol": null,
# "Description": null,
# "Rating": null,
# "Site": null,
# "OwnerId": "005B0000003TOI6IAO",
# "CreatedDate": "2017-08-18T14:46:22.000+0000",
# "CreatedById": "005B0000003TOI6IAO",
# "LastModifiedDate": "2017-08-18T14:46:22.000+0000",
# "LastModifiedById": "005B0000003TOI6IAO",
# "SystemModstamp": "2017-08-18T14:46:22.000+0000",
# "LastActivityDate": null,
# "LastViewedDate": null,
# "LastReferencedDate": null,
# "IsPartner": false,
# "IsCustomerPortal": false,
# "ChannelProgramName": null,
# "ChannelProgramLevelName": null,
# "Jigsaw": null,
# "JigsawCompanyId": null,
# "CleanStatus": "Pending",
# "AccountSource": null,
# "DunsNumber": null,
# "Tradestyle": null,
# "NaicsCode": null,
# "NaicsDesc": null,
# "YearStarted": null,
# "SicDesc": null,
# "DandbCompanyId": null,
# "CustomerPriority__c": "Low",
# "SLA__c": "Bronze",
# "Active__c": "Yes",
# "NumberofLocations__c": 2,
# "UpsellOpportunity__c": "No",
# "SLASerialNumber__c": "7425",
# "SLAExpirationDate__c": "2017-03-15"
# },
# {
# "attributes": {
# "type": "Account",
# "url": "/services/data/v58.0/sobjects/Account/001B000000UnQ2vIAF"
# },
# "Id": "001B000000UnQ2vIAF",
# "IsDeleted": false,
# "MasterRecordId": null,
# "Name": "Edge Communications",
# "Type": "Customer - Direct",
# "ParentId": null,
# "BillingStreet": "312 Constitution Place\nAustin, TX 78767\nUSA",
# "BillingCity": "Austin",
# "BillingState": "TX",
# "BillingPostalCode": null,
# "BillingCountry": null,
# "BillingLatitude": null,
# "BillingLongitude": null,
# "BillingGeocodeAccuracy": null,
# "BillingAddress": {
# "city": "Austin",
# "country": null,
# "geocodeAccuracy": null,
# "latitude": null,
# "longitude": null,
# "postalCode": null,
# "state": "TX",
# "street": "312 Constitution Place\nAustin, TX 78767\nUSA"
# },
# "ShippingStreet": "312 Constitution Place\nAustin, TX 78767\nUSA",
# "ShippingCity": null,
# "ShippingState": null,
# "ShippingPostalCode": null,
# "ShippingCountry": null,
# "ShippingLatitude": null,
# "ShippingLongitude": null,
# "ShippingGeocodeAccuracy": null,
# "ShippingAddress": {
# "city": null,
# "country": null,
# "geocodeAccuracy": null,
# "latitude": null,
# "longitude": null,
# "postalCode": null,
# "state": null,
# "street": "312 Constitution Place\nAustin, TX 78767\nUSA"
# },
# "Phone": "(512) 757-6000",
# "Fax": "(512) 757-9000",
# "AccountNumber": "CD451796",
# "Website": "http://edgecomm.com",
# "PhotoUrl": "/services/images/photo/001B000000UnQ2vIAF",
# "Sic": "6576",
# "Industry": "Electronics",
# "AnnualRevenue": 139000000,
# "NumberOfEmployees": 1000,
# "Ownership": "Public",
# "TickerSymbol": "EDGE",
# "Description": "Edge, founded in 1998, is a start-up based in Austin, TX. The company designs and manufactures a device to convert music from one digital format to another. Edge sells its product through retailers and its own website.",
# "Rating": "Hot",
# "Site": null,
# "OwnerId": "005B0000003TOI6IAO",
# "CreatedDate": "2017-08-18T14:46:22.000+0000",
# "CreatedById": "005B0000003TOI6IAO",
# "LastModifiedDate": "2017-08-18T14:46:22.000+0000",
# "LastModifiedById": "005B0000003TOI6IAO",
# "SystemModstamp": "2017-08-18T14:46:22.000+0000",
# "LastActivityDate": null,
# "LastViewedDate": null,
# "LastReferencedDate": null,
# "IsPartner": false,
# "IsCustomerPortal": false,
# "ChannelProgramName": null,
# "ChannelProgramLevelName": null,
# "Jigsaw": null,
# "JigsawCompanyId": null,
# "CleanStatus": "Pending",
# "AccountSource": null,
# "DunsNumber": null,
# "Tradestyle": null,
# "NaicsCode": null,
# "NaicsDesc": null,
# "YearStarted": null,
# "SicDesc": null,
# "DandbCompanyId": null,
# "CustomerPriority__c": "Medium",
# "SLA__c": "Silver",
# "Active__c": "Yes",
# "NumberofLocations__c": 2,
# "UpsellOpportunity__c": "Maybe",
# "SLASerialNumber__c": "2657",
# "SLAExpirationDate__c": "2016-09-12"
# },
# {
# "attributes": {
# "type": "Account",
# "url": "/services/data/v58.0/sobjects/Account/001B000000UnQ31IAF"
# },
# "Id": "001B000000UnQ31IAF",
# "IsDeleted": false,
# "MasterRecordId": null,
# "Name": "Express Logistics and Transport",
# "Type": "Customer - Channel",
# "ParentId": null,
# "BillingStreet": "620 SW 5th Avenue Suite 400\nPortland, Oregon 97204\nUnited States",
# "BillingCity": "Portland",
# "BillingState": "OR",
# "BillingPostalCode": null,
# "BillingCountry": null,
# "BillingLatitude": null,
# "BillingLongitude": null,
# "BillingGeocodeAccuracy": null,
# "BillingAddress": {
# "city": "Portland",
# "country": null,
# "geocodeAccuracy": null,
# "latitude": null,
# "longitude": null,
# "postalCode": null,
# "state": "OR",
# "street": "620 SW 5th Avenue Suite 400\nPortland, Oregon 97204\nUnited States"
# },
# "ShippingStreet": "620 SW 5th Avenue Suite 400\nPortland, Oregon 97204\nUnited States",
# "ShippingCity": null,
# "ShippingState": null,
# "ShippingPostalCode": null,
# "ShippingCountry": null,
# "ShippingLatitude": null,
# "ShippingLongitude": null,
# "ShippingGeocodeAccuracy": null,
# "ShippingAddress": {
# "city": null,
# "country": null,
# "geocodeAccuracy": null,
# "latitude": null,
# "longitude": null,
# "postalCode": null,
# "state": null,
# "street": "620 SW 5th Avenue Suite 400\nPortland, Oregon 97204\nUnited States"
# },
# "Phone": "(503) 421-7800",
# "Fax": "(503) 421-7801",
# "AccountNumber": "CC947211",
# "Website": "www.expressl&t.net",
# "PhotoUrl": "/services/images/photo/001B000000UnQ31IAF",
# "Sic": "8742",
# "Industry": "Transportation",
# "AnnualRevenue": 950000000,
# "NumberOfEmployees": 12300,
# "Ownership": "Public",
# "TickerSymbol": "EXLT",
# "Description": "Commerical logistics and transportation company.",
# "Rating": "Cold",
# "Site": null,
# "OwnerId": "005B0000003TOI6IAO",
# "CreatedDate": "2017-08-18T14:46:22.000+0000",
# "CreatedById": "005B0000003TOI6IAO",
# "LastModifiedDate": "2017-08-18T14:46:22.000+0000",
# "LastModifiedById": "005B0000003TOI6IAO",
# "SystemModstamp": "2017-08-18T14:46:22.000+0000",
# "LastActivityDate": null,
# "LastViewedDate": null,
# "LastReferencedDate": null,
# "IsPartner": false,
# "IsCustomerPortal": false,
# "ChannelProgramName": null,
# "ChannelProgramLevelName": null,
# "Jigsaw": null,
# "JigsawCompanyId": null,
# "CleanStatus": "Pending",
# "AccountSource": null,
# "DunsNumber": null,
# "Tradestyle": null,
# "NaicsCode": null,
# "NaicsDesc": null,
# "YearStarted": null,
# "SicDesc": null,
# "DandbCompanyId": null,
# "CustomerPriority__c": "Medium",
# "SLA__c": "Platinum",
# "Active__c": "Yes",
# "NumberofLocations__c": 150,
# "UpsellOpportunity__c": "Maybe",
# "SLASerialNumber__c": "4724",
# "SLAExpirationDate__c": "2017-03-15"
# },
# {
# "attributes": {
# "type": "Account",
# "url": "/services/data/v58.0/sobjects/Account/001B000000UnQ35IAF"
# },
# "Id": "001B000000UnQ35IAF",
# "IsDeleted": false,
# "MasterRecordId": null,
# "Name": "GenePoint",
# "Type": "Customer - Channel",
# "ParentId": null,
# "BillingStreet": "345 Shoreline Park\nMountain View, CA 94043\nUSA",
# "BillingCity": "Mountain View",
# "BillingState": "CA",
# "BillingPostalCode": null,
# "BillingCountry": null,
# "BillingLatitude": null,
# "BillingLongitude": null,
# "BillingGeocodeAccuracy": null,
# "BillingAddress": {
# "city": "Mountain View",
# "country": null,
# "geocodeAccuracy": null,
# "latitude": null,
# "longitude": null,
# "postalCode": null,
# "state": "CA",
# "street": "345 Shoreline Park\nMountain View, CA 94043\nUSA"
# },
# "ShippingStreet": "345 Shoreline Park\nMountain View, CA 94043\nUSA",
# "ShippingCity": null,
# "ShippingState": null,
# "ShippingPostalCode": null,
# "ShippingCountry": null,
# "ShippingLatitude": null,
# "ShippingLongitude": null,
# "ShippingGeocodeAccuracy": null,
# "ShippingAddress": {
# "city": null,
# "country": null,
# "geocodeAccuracy": null,
# "latitude": null,
# "longitude": null,
# "postalCode": null,
# "state": null,
# "street": "345 Shoreline Park\nMountain View, CA 94043\nUSA"
# },
# "Phone": "(650) 867-3450",
# "Fax": "(650) 867-9895",
# "AccountNumber": "CC978213",
# "Website": "www.genepoint.com",
# "PhotoUrl": "/services/images/photo/001B000000UnQ35IAF",
# "Sic": "3712",
# "Industry": "Biotechnology",
# "AnnualRevenue": 30000000,
# "NumberOfEmployees": 265,
# "Ownership": "Private",
# "TickerSymbol": null,
# "Description": "Genomics company engaged in mapping and sequencing of the human genome and developing gene-based drugs",
# "Rating": "Cold",
# "Site": null,
# "OwnerId": "005B0000003TOI6IAO",
# "CreatedDate": "2017-08-18T14:46:22.000+0000",
# "CreatedById": "005B0000003TOI6IAO",
# "LastModifiedDate": "2017-08-18T14:46:22.000+0000",
# "LastModifiedById": "005B0000003TOI6IAO",
# "SystemModstamp": "2017-08-18T14:46:22.000+0000",
# "LastActivityDate": null,
# "LastViewedDate": null,
# "LastReferencedDate": null,
# "IsPartner": false,
# "IsCustomerPortal": false,
# "ChannelProgramName": null,
# "ChannelProgramLevelName": null,
# "Jigsaw": null,
# "JigsawCompanyId": null,
# "CleanStatus": "Pending",
# "AccountSource": null,
# "DunsNumber": null,
# "Tradestyle": null,
# "NaicsCode": null,
# "NaicsDesc": null,
# "YearStarted": null,
# "SicDesc": null,
# "DandbCompanyId": null,
# "CustomerPriority__c": "Low",
# "SLA__c": "Bronze",
# "Active__c": "Yes",
# "NumberofLocations__c": 1,
# "UpsellOpportunity__c": "Yes",
# "SLASerialNumber__c": "7324",
# "SLAExpirationDate__c": "2017-03-15"
# }
# ]
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
totalSize = jResp.IntOf("totalSize")
done = jResp.BoolOf("done")
i = 0
count_i = jResp.SizeOfArray("records")
while i < count_i
jResp.put_I(i)
v_Type = jResp.stringOf("records[i].attributes.type")
v_Url = jResp.stringOf("records[i].attributes.url")
Id = jResp.stringOf("records[i].Id")
IsDeleted = jResp.BoolOf("records[i].IsDeleted")
MasterRecordId = jResp.stringOf("records[i].MasterRecordId")
Name = jResp.stringOf("records[i].Name")
v_Type = jResp.stringOf("records[i].Type")
ParentId = jResp.stringOf("records[i].ParentId")
BillingStreet = jResp.stringOf("records[i].BillingStreet")
BillingCity = jResp.stringOf("records[i].BillingCity")
BillingState = jResp.stringOf("records[i].BillingState")
BillingPostalCode = jResp.stringOf("records[i].BillingPostalCode")
BillingCountry = jResp.stringOf("records[i].BillingCountry")
BillingLatitude = jResp.stringOf("records[i].BillingLatitude")
BillingLongitude = jResp.stringOf("records[i].BillingLongitude")
BillingGeocodeAccuracy = jResp.stringOf("records[i].BillingGeocodeAccuracy")
City = jResp.stringOf("records[i].BillingAddress.city")
Country = jResp.stringOf("records[i].BillingAddress.country")
GeocodeAccuracy = jResp.stringOf("records[i].BillingAddress.geocodeAccuracy")
Latitude = jResp.stringOf("records[i].BillingAddress.latitude")
Longitude = jResp.stringOf("records[i].BillingAddress.longitude")
PostalCode = jResp.stringOf("records[i].BillingAddress.postalCode")
State = jResp.stringOf("records[i].BillingAddress.state")
Street = jResp.stringOf("records[i].BillingAddress.street")
ShippingStreet = jResp.stringOf("records[i].ShippingStreet")
ShippingCity = jResp.stringOf("records[i].ShippingCity")
ShippingState = jResp.stringOf("records[i].ShippingState")
ShippingPostalCode = jResp.stringOf("records[i].ShippingPostalCode")
ShippingCountry = jResp.stringOf("records[i].ShippingCountry")
ShippingLatitude = jResp.stringOf("records[i].ShippingLatitude")
ShippingLongitude = jResp.stringOf("records[i].ShippingLongitude")
ShippingGeocodeAccuracy = jResp.stringOf("records[i].ShippingGeocodeAccuracy")
ShippingAddress = jResp.stringOf("records[i].ShippingAddress")
Phone = jResp.stringOf("records[i].Phone")
Fax = jResp.stringOf("records[i].Fax")
AccountNumber = jResp.stringOf("records[i].AccountNumber")
Website = jResp.stringOf("records[i].Website")
PhotoUrl = jResp.stringOf("records[i].PhotoUrl")
Sic = jResp.stringOf("records[i].Sic")
Industry = jResp.stringOf("records[i].Industry")
AnnualRevenue = jResp.IntOf("records[i].AnnualRevenue")
NumberOfEmployees = jResp.IntOf("records[i].NumberOfEmployees")
Ownership = jResp.stringOf("records[i].Ownership")
TickerSymbol = jResp.stringOf("records[i].TickerSymbol")
Description = jResp.stringOf("records[i].Description")
Rating = jResp.stringOf("records[i].Rating")
Site = jResp.stringOf("records[i].Site")
OwnerId = jResp.stringOf("records[i].OwnerId")
CreatedDate = jResp.stringOf("records[i].CreatedDate")
CreatedById = jResp.stringOf("records[i].CreatedById")
LastModifiedDate = jResp.stringOf("records[i].LastModifiedDate")
LastModifiedById = jResp.stringOf("records[i].LastModifiedById")
SystemModstamp = jResp.stringOf("records[i].SystemModstamp")
LastActivityDate = jResp.stringOf("records[i].LastActivityDate")
LastViewedDate = jResp.stringOf("records[i].LastViewedDate")
LastReferencedDate = jResp.stringOf("records[i].LastReferencedDate")
IsPartner = jResp.BoolOf("records[i].IsPartner")
IsCustomerPortal = jResp.BoolOf("records[i].IsCustomerPortal")
ChannelProgramName = jResp.stringOf("records[i].ChannelProgramName")
ChannelProgramLevelName = jResp.stringOf("records[i].ChannelProgramLevelName")
Jigsaw = jResp.stringOf("records[i].Jigsaw")
JigsawCompanyId = jResp.stringOf("records[i].JigsawCompanyId")
CleanStatus = jResp.stringOf("records[i].CleanStatus")
AccountSource = jResp.stringOf("records[i].AccountSource")
DunsNumber = jResp.stringOf("records[i].DunsNumber")
Tradestyle = jResp.stringOf("records[i].Tradestyle")
NaicsCode = jResp.stringOf("records[i].NaicsCode")
NaicsDesc = jResp.stringOf("records[i].NaicsDesc")
YearStarted = jResp.stringOf("records[i].YearStarted")
SicDesc = jResp.stringOf("records[i].SicDesc")
DandbCompanyId = jResp.stringOf("records[i].DandbCompanyId")
CustomerPriority__c = jResp.stringOf("records[i].CustomerPriority__c")
SLA__c = jResp.stringOf("records[i].SLA__c")
Active__c = jResp.stringOf("records[i].Active__c")
NumberofLocations__c = jResp.IntOf("records[i].NumberofLocations__c")
UpsellOpportunity__c = jResp.stringOf("records[i].UpsellOpportunity__c")
SLASerialNumber__c = jResp.stringOf("records[i].SLASerialNumber__c")
SLAExpirationDate__c = jResp.stringOf("records[i].SLAExpirationDate__c")
ShippingAddressCity = jResp.stringOf("records[i].ShippingAddress.city")
ShippingAddressCountry = jResp.stringOf("records[i].ShippingAddress.country")
ShippingAddressGeocodeAccuracy = jResp.stringOf("records[i].ShippingAddress.geocodeAccuracy")
ShippingAddressLatitude = jResp.stringOf("records[i].ShippingAddress.latitude")
ShippingAddressLongitude = jResp.stringOf("records[i].ShippingAddress.longitude")
ShippingAddressPostalCode = jResp.stringOf("records[i].ShippingAddress.postalCode")
ShippingAddressState = jResp.stringOf("records[i].ShippingAddress.state")
ShippingAddressStreet = jResp.stringOf("records[i].ShippingAddress.street")
i = i + 1
end
Curl Command
curl -G -d "q=SELECT%20FIELDS%28All%29%20FROM%20ACCOUNT%20ORDER%20BY%20Name%20LIMIT%205"
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
https://domain.com/services/data/v{{version}}/query/
Postman Collection Item JSON
{
"name": "Query",
"request": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/query/?q=SELECT FIELDS(All) FROM ACCOUNT ORDER BY Name LIMIT 5",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"query",
""
],
"query": [
{
"key": "q",
"value": "SELECT FIELDS(All) FROM ACCOUNT ORDER BY Name LIMIT 5",
"description": "A SOQL query. Note that you will need to replace spaces with “+” characters in your query string to create a valid URI. An example query parameter string might look like: “SELECT+Name+FROM+MyObject”. If the SOQL query string is invalid, a MALFORMED_QUERY response is returned."
}
]
},
"description": "Executes the specified SOQL query.\n\nIf the query results are too large, the response contains the first batch of results and a query identifier in the nextRecordsUrl field of the response. The identifier can be used in an additional request to retrieve the next batch.\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_query.htm"
},
"response": [
{
"name": "Query",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/query/?q=SELECT FIELDS(All) FROM ACCOUNT ORDER BY Name LIMIT 5",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"query",
""
],
"query": [
{
"key": "q",
"value": "SELECT FIELDS(All) FROM ACCOUNT ORDER BY Name LIMIT 5",
"description": "A SOQL query. Note that you will need to replace spaces with “+” characters in your query string to create a valid URI. An example query parameter string might look like: “SELECT+Name+FROM+MyObject”. If the SOQL query string is invalid, a MALFORMED_QUERY response is returned."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Wed, 27 Sep 2023 15:27:00 GMT"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=63072000; includeSubDomains"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "X-Robots-Tag",
"value": "none"
},
{
"key": "Cache-Control",
"value": "no-cache,must-revalidate,max-age=0,no-store,private"
},
{
"key": "Sforce-Limit-Info",
"value": "api-usage=1/15000"
},
{
"key": "Content-Type",
"value": "application/json;charset=UTF-8"
},
{
"key": "Vary",
"value": "Accept-Encoding"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
}
],
"cookie": [
],
"body": "{\n \"totalSize\": 5,\n \"done\": true,\n \"records\": [\n {\n \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001B000000UnQ2wIAF\"\n },\n \"Id\": \"001B000000UnQ2wIAF\",\n \"IsDeleted\": false,\n \"MasterRecordId\": null,\n \"Name\": \"Burlington Textiles Corp of America\",\n \"Type\": \"Customer - Direct\",\n \"ParentId\": null,\n \"BillingStreet\": \"525 S. Lexington Ave\",\n \"BillingCity\": \"Burlington\",\n \"BillingState\": \"NC\",\n \"BillingPostalCode\": \"27215\",\n \"BillingCountry\": \"USA\",\n \"BillingLatitude\": null,\n \"BillingLongitude\": null,\n \"BillingGeocodeAccuracy\": null,\n \"BillingAddress\": {\n \"city\": \"Burlington\",\n \"country\": \"USA\",\n \"geocodeAccuracy\": null,\n \"latitude\": null,\n \"longitude\": null,\n \"postalCode\": \"27215\",\n \"state\": \"NC\",\n \"street\": \"525 S. Lexington Ave\"\n },\n \"ShippingStreet\": null,\n \"ShippingCity\": null,\n \"ShippingState\": null,\n \"ShippingPostalCode\": null,\n \"ShippingCountry\": null,\n \"ShippingLatitude\": null,\n \"ShippingLongitude\": null,\n \"ShippingGeocodeAccuracy\": null,\n \"ShippingAddress\": null,\n \"Phone\": \"(336) 222-7000\",\n \"Fax\": \"(336) 222-8000\",\n \"AccountNumber\": \"CD656092\",\n \"Website\": \"www.burlington.com\",\n \"PhotoUrl\": \"/services/images/photo/001B000000UnQ2wIAF\",\n \"Sic\": \"546732\",\n \"Industry\": \"Apparel\",\n \"AnnualRevenue\": 350000000,\n \"NumberOfEmployees\": 9000,\n \"Ownership\": \"Public\",\n \"TickerSymbol\": \"BTXT\",\n \"Description\": null,\n \"Rating\": \"Warm\",\n \"Site\": null,\n \"OwnerId\": \"005B0000003TOI6IAO\",\n \"CreatedDate\": \"2017-08-18T14:46:22.000+0000\",\n \"CreatedById\": \"005B0000003TOI6IAO\",\n \"LastModifiedDate\": \"2017-08-18T14:46:22.000+0000\",\n \"LastModifiedById\": \"005B0000003TOI6IAO\",\n \"SystemModstamp\": \"2017-08-18T14:46:22.000+0000\",\n \"LastActivityDate\": null,\n \"LastViewedDate\": null,\n \"LastReferencedDate\": null,\n \"IsPartner\": false,\n \"IsCustomerPortal\": false,\n \"ChannelProgramName\": null,\n \"ChannelProgramLevelName\": null,\n \"Jigsaw\": null,\n \"JigsawCompanyId\": null,\n \"CleanStatus\": \"Pending\",\n \"AccountSource\": null,\n \"DunsNumber\": null,\n \"Tradestyle\": null,\n \"NaicsCode\": null,\n \"NaicsDesc\": null,\n \"YearStarted\": null,\n \"SicDesc\": null,\n \"DandbCompanyId\": null,\n \"CustomerPriority__c\": null,\n \"SLA__c\": \"Silver\",\n \"Active__c\": null,\n \"NumberofLocations__c\": 6,\n \"UpsellOpportunity__c\": \"Maybe\",\n \"SLASerialNumber__c\": \"5367\",\n \"SLAExpirationDate__c\": \"2016-09-12\"\n },\n {\n \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001B000000UnQ2yIAF\"\n },\n \"Id\": \"001B000000UnQ2yIAF\",\n \"IsDeleted\": false,\n \"MasterRecordId\": null,\n \"Name\": \"Dickenson plc\",\n \"Type\": \"Customer - Channel\",\n \"ParentId\": null,\n \"BillingStreet\": \"1301 Hoch Drive\",\n \"BillingCity\": \"Lawrence\",\n \"BillingState\": \"KS\",\n \"BillingPostalCode\": \"66045\",\n \"BillingCountry\": \"USA\",\n \"BillingLatitude\": null,\n \"BillingLongitude\": null,\n \"BillingGeocodeAccuracy\": null,\n \"BillingAddress\": {\n \"city\": \"Lawrence\",\n \"country\": \"USA\",\n \"geocodeAccuracy\": null,\n \"latitude\": null,\n \"longitude\": null,\n \"postalCode\": \"66045\",\n \"state\": \"KS\",\n \"street\": \"1301 Hoch Drive\"\n },\n \"ShippingStreet\": \"1301 Hoch Drive\",\n \"ShippingCity\": \"Lawrence\",\n \"ShippingState\": \"KS\",\n \"ShippingPostalCode\": \"66045\",\n \"ShippingCountry\": \"USA\",\n \"ShippingLatitude\": null,\n \"ShippingLongitude\": null,\n \"ShippingGeocodeAccuracy\": null,\n \"ShippingAddress\": {\n \"city\": \"Lawrence\",\n \"country\": \"USA\",\n \"geocodeAccuracy\": null,\n \"latitude\": null,\n \"longitude\": null,\n \"postalCode\": \"66045\",\n \"state\": \"KS\",\n \"street\": \"1301 Hoch Drive\"\n },\n \"Phone\": \"(785) 241-6200\",\n \"Fax\": \"(785) 241-6201\",\n \"AccountNumber\": \"CC634267\",\n \"Website\": \"dickenson-consulting.com\",\n \"PhotoUrl\": \"/services/images/photo/001B000000UnQ2yIAF\",\n \"Sic\": \"6752\",\n \"Industry\": \"Consulting\",\n \"AnnualRevenue\": 50000000,\n \"NumberOfEmployees\": 120,\n \"Ownership\": \"Private\",\n \"TickerSymbol\": null,\n \"Description\": null,\n \"Rating\": null,\n \"Site\": null,\n \"OwnerId\": \"005B0000003TOI6IAO\",\n \"CreatedDate\": \"2017-08-18T14:46:22.000+0000\",\n \"CreatedById\": \"005B0000003TOI6IAO\",\n \"LastModifiedDate\": \"2017-08-18T14:46:22.000+0000\",\n \"LastModifiedById\": \"005B0000003TOI6IAO\",\n \"SystemModstamp\": \"2017-08-18T14:46:22.000+0000\",\n \"LastActivityDate\": null,\n \"LastViewedDate\": null,\n \"LastReferencedDate\": null,\n \"IsPartner\": false,\n \"IsCustomerPortal\": false,\n \"ChannelProgramName\": null,\n \"ChannelProgramLevelName\": null,\n \"Jigsaw\": null,\n \"JigsawCompanyId\": null,\n \"CleanStatus\": \"Pending\",\n \"AccountSource\": null,\n \"DunsNumber\": null,\n \"Tradestyle\": null,\n \"NaicsCode\": null,\n \"NaicsDesc\": null,\n \"YearStarted\": null,\n \"SicDesc\": null,\n \"DandbCompanyId\": null,\n \"CustomerPriority__c\": \"Low\",\n \"SLA__c\": \"Bronze\",\n \"Active__c\": \"Yes\",\n \"NumberofLocations__c\": 2,\n \"UpsellOpportunity__c\": \"No\",\n \"SLASerialNumber__c\": \"7425\",\n \"SLAExpirationDate__c\": \"2017-03-15\"\n },\n {\n \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001B000000UnQ2vIAF\"\n },\n \"Id\": \"001B000000UnQ2vIAF\",\n \"IsDeleted\": false,\n \"MasterRecordId\": null,\n \"Name\": \"Edge Communications\",\n \"Type\": \"Customer - Direct\",\n \"ParentId\": null,\n \"BillingStreet\": \"312 Constitution Place\\nAustin, TX 78767\\nUSA\",\n \"BillingCity\": \"Austin\",\n \"BillingState\": \"TX\",\n \"BillingPostalCode\": null,\n \"BillingCountry\": null,\n \"BillingLatitude\": null,\n \"BillingLongitude\": null,\n \"BillingGeocodeAccuracy\": null,\n \"BillingAddress\": {\n \"city\": \"Austin\",\n \"country\": null,\n \"geocodeAccuracy\": null,\n \"latitude\": null,\n \"longitude\": null,\n \"postalCode\": null,\n \"state\": \"TX\",\n \"street\": \"312 Constitution Place\\nAustin, TX 78767\\nUSA\"\n },\n \"ShippingStreet\": \"312 Constitution Place\\nAustin, TX 78767\\nUSA\",\n \"ShippingCity\": null,\n \"ShippingState\": null,\n \"ShippingPostalCode\": null,\n \"ShippingCountry\": null,\n \"ShippingLatitude\": null,\n \"ShippingLongitude\": null,\n \"ShippingGeocodeAccuracy\": null,\n \"ShippingAddress\": {\n \"city\": null,\n \"country\": null,\n \"geocodeAccuracy\": null,\n \"latitude\": null,\n \"longitude\": null,\n \"postalCode\": null,\n \"state\": null,\n \"street\": \"312 Constitution Place\\nAustin, TX 78767\\nUSA\"\n },\n \"Phone\": \"(512) 757-6000\",\n \"Fax\": \"(512) 757-9000\",\n \"AccountNumber\": \"CD451796\",\n \"Website\": \"http://edgecomm.com\",\n \"PhotoUrl\": \"/services/images/photo/001B000000UnQ2vIAF\",\n \"Sic\": \"6576\",\n \"Industry\": \"Electronics\",\n \"AnnualRevenue\": 139000000,\n \"NumberOfEmployees\": 1000,\n \"Ownership\": \"Public\",\n \"TickerSymbol\": \"EDGE\",\n \"Description\": \"Edge, founded in 1998, is a start-up based in Austin, TX. The company designs and manufactures a device to convert music from one digital format to another. Edge sells its product through retailers and its own website.\",\n \"Rating\": \"Hot\",\n \"Site\": null,\n \"OwnerId\": \"005B0000003TOI6IAO\",\n \"CreatedDate\": \"2017-08-18T14:46:22.000+0000\",\n \"CreatedById\": \"005B0000003TOI6IAO\",\n \"LastModifiedDate\": \"2017-08-18T14:46:22.000+0000\",\n \"LastModifiedById\": \"005B0000003TOI6IAO\",\n \"SystemModstamp\": \"2017-08-18T14:46:22.000+0000\",\n \"LastActivityDate\": null,\n \"LastViewedDate\": null,\n \"LastReferencedDate\": null,\n \"IsPartner\": false,\n \"IsCustomerPortal\": false,\n \"ChannelProgramName\": null,\n \"ChannelProgramLevelName\": null,\n \"Jigsaw\": null,\n \"JigsawCompanyId\": null,\n \"CleanStatus\": \"Pending\",\n \"AccountSource\": null,\n \"DunsNumber\": null,\n \"Tradestyle\": null,\n \"NaicsCode\": null,\n \"NaicsDesc\": null,\n \"YearStarted\": null,\n \"SicDesc\": null,\n \"DandbCompanyId\": null,\n \"CustomerPriority__c\": \"Medium\",\n \"SLA__c\": \"Silver\",\n \"Active__c\": \"Yes\",\n \"NumberofLocations__c\": 2,\n \"UpsellOpportunity__c\": \"Maybe\",\n \"SLASerialNumber__c\": \"2657\",\n \"SLAExpirationDate__c\": \"2016-09-12\"\n },\n {\n \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001B000000UnQ31IAF\"\n },\n \"Id\": \"001B000000UnQ31IAF\",\n \"IsDeleted\": false,\n \"MasterRecordId\": null,\n \"Name\": \"Express Logistics and Transport\",\n \"Type\": \"Customer - Channel\",\n \"ParentId\": null,\n \"BillingStreet\": \"620 SW 5th Avenue Suite 400\\nPortland, Oregon 97204\\nUnited States\",\n \"BillingCity\": \"Portland\",\n \"BillingState\": \"OR\",\n \"BillingPostalCode\": null,\n \"BillingCountry\": null,\n \"BillingLatitude\": null,\n \"BillingLongitude\": null,\n \"BillingGeocodeAccuracy\": null,\n \"BillingAddress\": {\n \"city\": \"Portland\",\n \"country\": null,\n \"geocodeAccuracy\": null,\n \"latitude\": null,\n \"longitude\": null,\n \"postalCode\": null,\n \"state\": \"OR\",\n \"street\": \"620 SW 5th Avenue Suite 400\\nPortland, Oregon 97204\\nUnited States\"\n },\n \"ShippingStreet\": \"620 SW 5th Avenue Suite 400\\nPortland, Oregon 97204\\nUnited States\",\n \"ShippingCity\": null,\n \"ShippingState\": null,\n \"ShippingPostalCode\": null,\n \"ShippingCountry\": null,\n \"ShippingLatitude\": null,\n \"ShippingLongitude\": null,\n \"ShippingGeocodeAccuracy\": null,\n \"ShippingAddress\": {\n \"city\": null,\n \"country\": null,\n \"geocodeAccuracy\": null,\n \"latitude\": null,\n \"longitude\": null,\n \"postalCode\": null,\n \"state\": null,\n \"street\": \"620 SW 5th Avenue Suite 400\\nPortland, Oregon 97204\\nUnited States\"\n },\n \"Phone\": \"(503) 421-7800\",\n \"Fax\": \"(503) 421-7801\",\n \"AccountNumber\": \"CC947211\",\n \"Website\": \"www.expressl&t.net\",\n \"PhotoUrl\": \"/services/images/photo/001B000000UnQ31IAF\",\n \"Sic\": \"8742\",\n \"Industry\": \"Transportation\",\n \"AnnualRevenue\": 950000000,\n \"NumberOfEmployees\": 12300,\n \"Ownership\": \"Public\",\n \"TickerSymbol\": \"EXLT\",\n \"Description\": \"Commerical logistics and transportation company.\",\n \"Rating\": \"Cold\",\n \"Site\": null,\n \"OwnerId\": \"005B0000003TOI6IAO\",\n \"CreatedDate\": \"2017-08-18T14:46:22.000+0000\",\n \"CreatedById\": \"005B0000003TOI6IAO\",\n \"LastModifiedDate\": \"2017-08-18T14:46:22.000+0000\",\n \"LastModifiedById\": \"005B0000003TOI6IAO\",\n \"SystemModstamp\": \"2017-08-18T14:46:22.000+0000\",\n \"LastActivityDate\": null,\n \"LastViewedDate\": null,\n \"LastReferencedDate\": null,\n \"IsPartner\": false,\n \"IsCustomerPortal\": false,\n \"ChannelProgramName\": null,\n \"ChannelProgramLevelName\": null,\n \"Jigsaw\": null,\n \"JigsawCompanyId\": null,\n \"CleanStatus\": \"Pending\",\n \"AccountSource\": null,\n \"DunsNumber\": null,\n \"Tradestyle\": null,\n \"NaicsCode\": null,\n \"NaicsDesc\": null,\n \"YearStarted\": null,\n \"SicDesc\": null,\n \"DandbCompanyId\": null,\n \"CustomerPriority__c\": \"Medium\",\n \"SLA__c\": \"Platinum\",\n \"Active__c\": \"Yes\",\n \"NumberofLocations__c\": 150,\n \"UpsellOpportunity__c\": \"Maybe\",\n \"SLASerialNumber__c\": \"4724\",\n \"SLAExpirationDate__c\": \"2017-03-15\"\n },\n {\n \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001B000000UnQ35IAF\"\n },\n \"Id\": \"001B000000UnQ35IAF\",\n \"IsDeleted\": false,\n \"MasterRecordId\": null,\n \"Name\": \"GenePoint\",\n \"Type\": \"Customer - Channel\",\n \"ParentId\": null,\n \"BillingStreet\": \"345 Shoreline Park\\nMountain View, CA 94043\\nUSA\",\n \"BillingCity\": \"Mountain View\",\n \"BillingState\": \"CA\",\n \"BillingPostalCode\": null,\n \"BillingCountry\": null,\n \"BillingLatitude\": null,\n \"BillingLongitude\": null,\n \"BillingGeocodeAccuracy\": null,\n \"BillingAddress\": {\n \"city\": \"Mountain View\",\n \"country\": null,\n \"geocodeAccuracy\": null,\n \"latitude\": null,\n \"longitude\": null,\n \"postalCode\": null,\n \"state\": \"CA\",\n \"street\": \"345 Shoreline Park\\nMountain View, CA 94043\\nUSA\"\n },\n \"ShippingStreet\": \"345 Shoreline Park\\nMountain View, CA 94043\\nUSA\",\n \"ShippingCity\": null,\n \"ShippingState\": null,\n \"ShippingPostalCode\": null,\n \"ShippingCountry\": null,\n \"ShippingLatitude\": null,\n \"ShippingLongitude\": null,\n \"ShippingGeocodeAccuracy\": null,\n \"ShippingAddress\": {\n \"city\": null,\n \"country\": null,\n \"geocodeAccuracy\": null,\n \"latitude\": null,\n \"longitude\": null,\n \"postalCode\": null,\n \"state\": null,\n \"street\": \"345 Shoreline Park\\nMountain View, CA 94043\\nUSA\"\n },\n \"Phone\": \"(650) 867-3450\",\n \"Fax\": \"(650) 867-9895\",\n \"AccountNumber\": \"CC978213\",\n \"Website\": \"www.genepoint.com\",\n \"PhotoUrl\": \"/services/images/photo/001B000000UnQ35IAF\",\n \"Sic\": \"3712\",\n \"Industry\": \"Biotechnology\",\n \"AnnualRevenue\": 30000000,\n \"NumberOfEmployees\": 265,\n \"Ownership\": \"Private\",\n \"TickerSymbol\": null,\n \"Description\": \"Genomics company engaged in mapping and sequencing of the human genome and developing gene-based drugs\",\n \"Rating\": \"Cold\",\n \"Site\": null,\n \"OwnerId\": \"005B0000003TOI6IAO\",\n \"CreatedDate\": \"2017-08-18T14:46:22.000+0000\",\n \"CreatedById\": \"005B0000003TOI6IAO\",\n \"LastModifiedDate\": \"2017-08-18T14:46:22.000+0000\",\n \"LastModifiedById\": \"005B0000003TOI6IAO\",\n \"SystemModstamp\": \"2017-08-18T14:46:22.000+0000\",\n \"LastActivityDate\": null,\n \"LastViewedDate\": null,\n \"LastReferencedDate\": null,\n \"IsPartner\": false,\n \"IsCustomerPortal\": false,\n \"ChannelProgramName\": null,\n \"ChannelProgramLevelName\": null,\n \"Jigsaw\": null,\n \"JigsawCompanyId\": null,\n \"CleanStatus\": \"Pending\",\n \"AccountSource\": null,\n \"DunsNumber\": null,\n \"Tradestyle\": null,\n \"NaicsCode\": null,\n \"NaicsDesc\": null,\n \"YearStarted\": null,\n \"SicDesc\": null,\n \"DandbCompanyId\": null,\n \"CustomerPriority__c\": \"Low\",\n \"SLA__c\": \"Bronze\",\n \"Active__c\": \"Yes\",\n \"NumberofLocations__c\": 1,\n \"UpsellOpportunity__c\": \"Yes\",\n \"SLASerialNumber__c\": \"7324\",\n \"SLAExpirationDate__c\": \"2017-03-15\"\n }\n ]\n}"
}
]
}
