{ "opencollection": "1.0.0", "info": { "name": "Salesforce REST API", "version": "v63.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Versions", "type": "folder" }, "items": [ { "info": { "name": "Salesforce List Available Api Versions", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/" }, "docs": "Returns a list of all Salesforce REST API versions available on this instance. Each entry includes the version number, label, and URL. Use this to discover the latest supported version before building integrations.\n" } ] }, { "info": { "name": "SObjects", "type": "folder" }, "items": [ { "info": { "name": "Salesforce List All Sobjects", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/sobjects" }, "docs": "Returns a list of all available SObject types in the org, including both standard and custom objects. Each entry includes the object name, label, key prefix, and whether the object is queryable, searchable, and retrievable.\n" }, { "info": { "name": "Salesforce Describe an Sobject", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/sobjects/:sobjectType", "params": [ { "name": "sobjectType", "value": "", "type": "path", "description": "The API name of the Salesforce SObject type (e.g., Account, Contact, Opportunity, MyCustomObject__c).\n" } ] }, "docs": "Returns metadata about a specific SObject type, including field definitions, relationships, and available REST endpoints. This is equivalent to calling the describe endpoint but returns a shorter summary. For the full field list use /sobjects/{sobjectType}/describe.\n" }, { "info": { "name": "Salesforce Create a New Record", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.salesforce.com/services/data/v{version}/sobjects/:sobjectType", "params": [ { "name": "sobjectType", "value": "", "type": "path", "description": "The API name of the Salesforce SObject type (e.g., Account, Contact, Opportunity, MyCustomObject__c).\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new record of the specified SObject type. The request body must contain the field values for the new record in JSON format. Returns the ID of the newly created record on success.\n" }, { "info": { "name": "Salesforce Get a Record by Id", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/sobjects/:sobjectType/:id", "params": [ { "name": "sobjectType", "value": "", "type": "path", "description": "The API name of the Salesforce SObject type (e.g., Account, Contact, Opportunity, MyCustomObject__c).\n" }, { "name": "id", "value": "", "type": "path", "description": "The 18-character Salesforce record ID." } ] }, "docs": "Retrieves a single SObject record by its 18-character ID. Returns all accessible fields for the record. To retrieve only specific fields, use a SOQL query via the /query endpoint instead.\n" }, { "info": { "name": "Salesforce Update a Record", "type": "http" }, "http": { "method": "PATCH", "url": "https://{instance}.salesforce.com/services/data/v{version}/sobjects/:sobjectType/:id", "params": [ { "name": "sobjectType", "value": "", "type": "path", "description": "The API name of the Salesforce SObject type (e.g., Account, Contact, Opportunity, MyCustomObject__c).\n" }, { "name": "id", "value": "", "type": "path", "description": "The 18-character Salesforce record ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing SObject record identified by its 18-character ID. Only the fields included in the request body are updated; omitted fields retain their current values. Returns no body on success.\n" }, { "info": { "name": "Salesforce Delete a Record", "type": "http" }, "http": { "method": "DELETE", "url": "https://{instance}.salesforce.com/services/data/v{version}/sobjects/:sobjectType/:id", "params": [ { "name": "sobjectType", "value": "", "type": "path", "description": "The API name of the Salesforce SObject type (e.g., Account, Contact, Opportunity, MyCustomObject__c).\n" }, { "name": "id", "value": "", "type": "path", "description": "The 18-character Salesforce record ID." } ] }, "docs": "Deletes an existing SObject record by its 18-character ID. The record is moved to the Recycle Bin unless the object does not support soft delete, in which case it is permanently removed.\n" }, { "info": { "name": "Salesforce Get a Blob Field Value", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/sobjects/:sobjectType/:id/:blobField", "params": [ { "name": "sobjectType", "value": "", "type": "path", "description": "The API name of the Salesforce SObject type (e.g., Account, Contact, Opportunity, MyCustomObject__c).\n" }, { "name": "id", "value": "", "type": "path", "description": "The 18-character Salesforce record ID." }, { "name": "blobField", "value": "example_value", "type": "path", "description": "The API name of the blob field to retrieve (e.g., Body, VersionData, Photo).\n" } ] }, "docs": "Retrieves the binary content of a blob (binary large object) field on an SObject record. Examples include the Body field on Attachment or VersionData on ContentVersion. Returns the raw binary content with the appropriate MIME type.\n" }, { "info": { "name": "Salesforce Full Describe of an Sobject", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/sobjects/:sobjectType/describe", "params": [ { "name": "sobjectType", "value": "", "type": "path", "description": "The API name of the Salesforce SObject type (e.g., Account, Contact, Opportunity, MyCustomObject__c).\n" } ] }, "docs": "Returns a complete description of the specified SObject type, including all field definitions with their data types, labels, picklist values, relationship metadata, and child relationships. Use this endpoint when you need detailed schema information for a specific object type.\n" } ] }, { "info": { "name": "Query", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Execute a Soql Query", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.salesforce.com/services/data/v{version}/query", "body": { "type": "json", "data": "{}" } }, "docs": "Executes a SOQL (Salesforce Object Query Language) query and returns matching records. The query is passed in the request body as a JSON object with a \"q\" property. If results span multiple pages, a nextRecordsUrl is included to retrieve the next batch.\n" }, { "info": { "name": "Salesforce Get the Next Page of Query Results", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/query/:queryId", "params": [ { "name": "queryId", "value": "500123", "type": "path", "description": "The query ID token from the nextRecordsUrl of a previous query response.\n" } ] }, "docs": "Retrieves the next page of results from a paginated SOQL query. The queryId is obtained from the nextRecordsUrl in a previous query response. Continue calling this endpoint until the done field in the response is true.\n" } ] }, { "info": { "name": "QueryAll", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Execute a Queryall (includes Deleted Records)", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.salesforce.com/services/data/v{version}/queryAll", "body": { "type": "json", "data": "{}" } }, "docs": "Executes a SOQL query that includes soft-deleted records and archived records in the results, unlike the standard /query endpoint which excludes them. Use this endpoint for data recovery, audit trails, or replication scenarios where deleted records must be included.\n" } ] }, { "info": { "name": "Search", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Execute a Sosl Search", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/search", "params": [ { "name": "q", "value": "FIND {Jane Smith} IN ALL FIELDS RETURNING Contact(Id, Name, Email), Account(Id, Name)", "type": "query", "description": "The SOSL search string to execute. Must include a FIND clause and optionally IN, RETURNING, and WITH clauses.\n" } ] }, "docs": "Executes a SOSL (Salesforce Object Search Language) search query across multiple objects simultaneously. The SOSL query is passed as a query parameter. Returns matching records from all specified objects, supporting full-text search capabilities.\n" } ] }, { "info": { "name": "Limits", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Get Org Api Limits", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/limits" }, "docs": "Returns the current API limit usage and remaining quotas for the Salesforce org. Includes limits for daily API requests, bulk API jobs, streaming API events, and other governor limits. Use this endpoint to monitor API consumption and avoid hitting limits.\n" } ] }, { "info": { "name": "Recent", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Get Recently Viewed Records", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/recent", "params": [ { "name": "recentlyViewedCount", "value": "42", "type": "query", "description": "The number of recently viewed records to return. Defaults to 200. Maximum is 200.\n" } ] }, "docs": "Returns a list of recently viewed and referenced records for the currently authenticated user. Records are ordered by the most recently viewed first. Useful for building recently visited navigation features in custom applications.\n" } ] }, { "info": { "name": "AppMenu", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Get the App Switcher Menu", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/appMenu/AppSwitcher" }, "docs": "Returns the list of applications available in the Salesforce App Switcher menu for the currently authenticated user. Each entry includes the app label, icon URL, and navigation URL. Use this to build custom navigation or app launchers in connected applications.\n" } ] }, { "info": { "name": "Composite", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Execute a Batch of Requests", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.salesforce.com/services/data/v{version}/composite/batch", "body": { "type": "json", "data": "{}" } }, "docs": "Executes up to 25 independent REST API subrequests in a single HTTP call. All requests are processed independently; failure of one does not affect others. Returns an array of results in the same order as the subrequests. Use this to reduce the number of round trips when making multiple unrelated requests.\n" }, { "info": { "name": "Salesforce Execute a Composite Request With Dependent Subrequests", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.salesforce.com/services/data/v{version}/composite", "body": { "type": "json", "data": "{}" } }, "docs": "Executes a series of REST API requests where later requests can reference the results of earlier requests using reference IDs. Supports up to 25 subrequests. If any subrequest fails and allOrNone is true, all changes are rolled back. Use this for complex multi-step operations where later steps depend on earlier results.\n" }, { "info": { "name": "Salesforce Sobject Collections Create", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.salesforce.com/services/data/v{version}/composite/sobjects", "body": { "type": "json", "data": "{}" } }, "docs": "Creates up to 200 records in a single API call using SObject Collections. All records must be of the same or different SObject types. If allOrNone is true, all records must succeed or none are committed. Returns an array of save results with IDs or errors for each record.\n" }, { "info": { "name": "Salesforce Sobject Collections Update", "type": "http" }, "http": { "method": "PATCH", "url": "https://{instance}.salesforce.com/services/data/v{version}/composite/sobjects", "body": { "type": "json", "data": "{}" } }, "docs": "Updates up to 200 records in a single API call using SObject Collections. Each record must include its ID and the fields to update. If allOrNone is true, all updates must succeed or none are committed. Returns an array of save results for each record.\n" }, { "info": { "name": "Salesforce Sobject Collections Delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://{instance}.salesforce.com/services/data/v{version}/composite/sobjects", "params": [ { "name": "ids", "value": "001Dn00000pFakE001,001Dn00000pFakE002", "type": "query", "description": "Comma-separated list of up to 200 record IDs to delete.\n" }, { "name": "allOrNone", "value": "true", "type": "query", "description": "If true, all records must be deleted successfully or none are committed. Defaults to false.\n" } ] }, "docs": "Deletes up to 200 records in a single API call using SObject Collections. Record IDs are passed as a comma-separated query parameter. If allOrNone is true, all deletions must succeed or none are committed.\n" }, { "info": { "name": "Salesforce Sobject Collections Retrieve", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/composite/sobjects/:sobjectType", "params": [ { "name": "sobjectType", "value": "", "type": "path", "description": "The API name of the Salesforce SObject type (e.g., Account, Contact, Opportunity, MyCustomObject__c).\n" }, { "name": "ids", "value": "example_value", "type": "query", "description": "Comma-separated list of up to 2000 record IDs to retrieve.\n" }, { "name": "fields", "value": "example_value", "type": "query", "description": "Comma-separated list of field names to return for each record. Returns all accessible fields if not specified.\n" } ] }, "docs": "Retrieves up to 2000 records of the specified SObject type in a single API call. Record IDs are passed as a comma-separated query parameter. All records must be of the same SObject type. Returns all accessible fields for each record.\n" } ] } ], "bundled": true }