How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Salesforce Records API

The Records API from Salesforce — 8 operation(s) for records.

Salesforce Records API is one of 294 APIs that Salesforce publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Records. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, a getting-started guide, and 1 JSON Schema.

This API exposes 11 operations across 8 paths, and defines 60 schemas. It is described by OpenAPI 3.1.0, at version v63.0.

Requests are made against a single base URL, https://{instance}.salesforce.com/services/data/v{version}/jobs.

11 operations 8 paths 60 schemas 1 DELETE7 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v63.0
Base URL
https://{instance}.salesforce.com/services/data
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Salesforce Records API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — OAuth 2.0 Bearer token obtained from the Salesforce OAuth 2.0 token endpoint. Include this token in the Authorization header as "Bearer {accesstoken}".

Paths & Operations 11

Across 8 paths, the API surfaces 11 operations — 1 DELETE, 7 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Records 11
GET
/data/v64.0/ui-api/list-records/{LIST_VIEW_ID}
Salesforce Get List View Records by Id
GetListViewRecordsbyID 1 param → 200
GET
/data/v64.0/ui-api/list-records/{SOBJECT_API_NAME}/{LIST_VIEW_API_NAME}
Salesforce Get List View Records by Api Name
GetListViewRecordsbyAPIName 2 params → 200
POST
/data/v64.0/ui-api/list-records/{SOBJECT_API_NAME}/{LIST_VIEW_API_NAME}
Salesforce Get List View Records
GetListViewRecords 2 params body → 200
GET
/data/v64.0/search/suggestions
Salesforce Search for Records Suggested by Autocomplete and Instant Results
SearchforRecordsSuggestedbyAutocompleteandInstantResults 3 params → 200
GET
/data/v64.0/tooling/sobjects/{SOBJECT_API_NAME}/{RECORD_ID}
Salesforce Access Records
AccessRecords 2 params → 200
GET
/data/v64.0/ui-api/records/{RECORD_ID}/child-relationships/{RELATIONSHIP_NAME}
Salesforce Get Child Records
GetChildRecords 2 params → 200
GET
/data/v64.0/ui-api/records/batch/{RECORD_IDS}
Salesforce Get a Batch of Records
GetaBatchofRecords 1 param → 200
GET
/records/{recordId}
Salesforce Get a Record
getRecord 5 params → 200400401403404
PATCH
/records/{recordId}
Salesforce Update a Record
updateRecord 2 params body → 200400404
DELETE
/records/{recordId}
Salesforce Delete a Record
deleteRecord 1 param → 204404
POST
/records
Salesforce Create a Record
createRecord body → 201400

Schemas 60

The contract defines 60 schemas that model the data the API accepts and returns. The most detailed are AccessRecords (19 properties), Fields18 (17 properties), GetListViewRecordsperAPIName (16 properties), GetListViewRecords (16 properties). Each schema is shown below with its type and property counts.

Fields40
object
12 properties 12 required
AccountId2
object
2 properties 2 required
GetaBatchofRecords
object
2 properties 2 required
Result6
object
11 properties 11 required
Value
object
11 properties 11 required
Type10
object
2 properties 2 required
Industry2
object
2 properties 2 required
PhotoUrl4
object
2 properties 2 required
GetChildRecords
object
8 properties 8 required
RecordRepresentation
object
A Salesforce record with field values and UI metadata
12 properties
Location
object
2 properties 2 required
Owner11
object
2 properties 2 required
BillingState2
object
2 properties 2 required
SystemModstamp10
object
2 properties 2 required
BillingCountry2
object
2 properties 2 required
CreatedDate14
object
2 properties 2 required
Name21
object
2 properties 2 required
Value22
object
10 properties 7 required
Results4
object
2 properties 2 required
Fields41
object
7 properties 7 required
Records4
object
10 properties 10 required
Fields16
object
3 properties 3 required
Fields18
object
17 properties 17 required
Phone5
object
2 properties 2 required
Parent7
object
2 properties 2 required
TableDeclaration
object
6 properties 6 required
GetListViewRecordsbyID
object
16 properties 16 required
Owner6
object
2 properties 2 required
Constructor
object
7 properties 7 required
Alias4
object
2 properties 2 required
GetListViewRecordsperAPIName
object
16 properties 16 required
BillingStreet2
object
2 properties 2 required
LastModifiedById5
object
2 properties 2 required
Phone9
object
2 properties 2 required
LastModifiedDate14
object
2 properties 2 required
ListReference
object
4 properties 4 required
BillingCountry3
object
2 properties 2 required
Records1
object
11 properties 11 required
SymbolTable
object
13 properties 13 required
Fields8
object
2 properties 2 required
Type13
object
2 properties 2 required
GetListViewRecordsRequest
object
5 properties 5 required
AccessRecords
object
19 properties 19 required
Method
object
8 properties 8 required
RecordInput
object
Input for creating or updating a record
2 properties 2 required
Annotation
object
1 property 1 required
BillingPostalCode2
object
2 properties 2 required
OwnerId4
object
2 properties 2 required
Site2
object
2 properties 2 required
ErrorResponse
object
API error response
2 properties
AnnualRevenue2
object
2 properties 2 required
ParentId2
object
2 properties 2 required
GetListViewRecords
object
16 properties 16 required
Metadata17
object
4 properties 4 required
FieldValueRepresentation
object
A field value with display metadata
2 properties
Website5
object
2 properties 2 required
Parameter5
object
2 properties 2 required
Id8
object
2 properties 2 required
Attributes4
object
2 properties 2 required
BillingCity2
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

salesforce-records-api-openapi.yml Raw ↑

Other APIs Salesforce publishes across the network.

Salesforce REST API
Salesforce SOAP API
Salesforce Bulk API
Salesforce Streaming API
Salesforce Metadata API
Salesforce Tooling API
Salesforce Connect API (Chatter)
Salesforce Analytics REST API
Salesforce Reports and Dashboards REST API
Salesforce Einstein Platform Services API
Salesforce Einstein Prediction Service API
Salesforce GraphQL API
Where this information came from

This is an independent, third-party profile of Salesforce Records API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.