Quick Start

Review this short demonstration of how the Salesforce Industries REST API works.

A basic Salesforce Industries REST API request has this format.

1/services/apexrest/package namespace/current version/resource name/optional parameters

The package namespace value is omitted for orgs that don’t use a namespace. If you don’t know whether your org has a namespace, here’s how to check.

For example, this GET request returns all individuals in the org.

1/services/apexrest/org1_gs0/v1/individual/

Here’s the response with three records returned, with most values omitted for readability.

1{
2  "statusCode" : 3,
3  "responseBody" : {
4    "nextRecordUrl" : null,
5    "individuals" : {
6      "001B000000AXnplIAD1454697446538" : {
7        "org1_gs0__birthdate__c" : "None ,",
8        [Values omitted]
9        "isdeleted" : false
10      },
11      "001B000000AXncDIAT1454697283406" : {
12        "org1_gs0__birthdate__c" : "None ,",
13        [Values omitted]
14        "isdeleted" : false
15      },
16      "001B000000AXnQ2IAL1454697097426" : {
17        "org1_gs0__birthdate__c" : "None ,",
18        [Values omitted]
19        "isdeleted" : false
20      }
21    }
22  },
23  "message" : " Number of Individuals retrieved: 3"
24}

You can retrieve up to 200 records at once. If there are more than 200 records, the nextRecordUrl value shows the limit used and the offset to the next batch of records. For example, if this request had returned 200 records and more records were available, the next record value would be "nextRecordUrl" : "/v1/individual/?limit=200&offset=200".

Industries REST API Developer Guide

Quick Start