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 Lists API

The Lists API from Salesforce — 20 operation(s) for lists.

Salesforce Lists 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 List. 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 22 operations across 20 paths, and defines 73 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.

22 operations 20 paths 73 schemas 20 GET2 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 Lists 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 22

Across 20 paths, the API surfaces 22 operations — 20 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Lists 22
GET
/data/v64.0/named-credentials/external-credentials
Salesforce List External Credentials
ListExternalCredentials → 200
GET
/data/v64.0/named-credentials/named-credential-setup
Salesforce List Named Credentials
ListNamedCredentials → 200
GET
/data/v64.0/tooling/query
Salesforce List Named Credentials
Listnamedcredentials 1 param → 200
GET
/data/v64.0/chatter/groups
Salesforce List of Groups
ListofGroups → 200
POST
/data/v64.0/chatter/groups
Salesforce List of Groups - Post
ListofGroups-POST 8 params → 201
GET
/data/v64.0/query
Salesforce List Event Relay Feedback Items
Listeventrelayfeedbackitems 1 param → 200
GET
/data/v64.0/ui-api/actions/record/{RECORD_ID}/related-list/{RELATED_LIST_IDS}
Salesforce Get Related List Actions
GetRelatedListActions 2 params → 200
GET
/data/v64.0/ui-api/actions/record/{RECORD_ID}/related-list-record/{RELATED_LIST_RECORD_IDS}
Salesforce Get Related List Record Actions
GetRelatedListRecordActions 2 params → 200
GET
/data/v64.0/ui-api/actions/list-view/{LIST_VIEW_IDS}
Salesforce Get List View Header Actions
GetListViewHeaderActions 1 param → 200
GET
/data/v64.0/ui-api/actions/list-view-record/{RECORD_IDS}
Salesforce Get List View Record Actions
GetListViewRecordActions 1 param → 200
GET
/data/v64.0/ui-api/actions/list-view-chart/{SOBJECT_API_NAME}
Salesforce Get List View Chart Actions
GetListViewChartActions 1 param → 200
GET
/data/v64.0/ui-api/actions/mru-list/{SOBJECT_API_NAMES}
Salesforce Get Mru List View Actions
GetMRUListViewActions 1 param → 200
GET
/data/v64.0/sobjects/{SOBJECT_API_NAME}/listviews
Salesforce List Views
ListViews 2 params → 200
GET
/data/v64.0/sobjects/{SOBJECT_API_NAME}/listviews/{QUERY_LOCATOR}/describe
Salesforce List View Describe
ListViewDescribe 3 params → 200
GET
/data/v64.0/sobjects/{SOBJECT_API_NAME}/listviews/{LIST_VIEW_ID}/results
Salesforce List View Results
ListViewResults 3 params → 200
GET
/data/v64.0/ui-api/list-info/{SOBJECT_API_NAME}
Salesforce Get List Views for an Object
GetListViewsforanObject 1 param → 200
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/ui-api/list-info/{LIST_VIEW_ID}
Salesforce Get List View Metadata by Id
GetListViewMetadatabyID 1 param → 200
GET
/data/v64.0/ui-api/list-info/{SOBJECT_API_NAME}/{LIST_VIEW_API_NAME}
Salesforce Get List View Metadata by Api Name
GetListViewMetadatabyAPIName 2 params → 200
GET
/data/v64.0/support/knowledgeArticles
Salesforce Articles List
ArticlesList 1 param → 200

Schemas 73

The contract defines 73 schemas that model the data the API accepts and returns. The most detailed are SuccessfulListofGroups-POST (25 properties), Group (25 properties), Record11 (20 properties), Actions10 (19 properties). Each schema is shown below with its type and property counts.

Fields40
object
12 properties 12 required
00358000006woxwAAA
object
3 properties 3 required
Actions22
object
19 properties 19 required
00B58000002ssinEAA
object
3 properties 3 required
ColumnWidths
object
6 properties 6 required
GetListViewsforanObject
object
12 properties 12 required
SuccessfulListofGroups
object
4 properties 4 required
Owner11
object
2 properties 2 required
Motif
object
5 properties 5 required
Photo15
object
7 properties 7 required
Actions12
object
19 properties 19 required
SystemModstamp10
object
2 properties 2 required
CreatedDate14
object
2 properties 2 required
Information
object
2 properties 2 required
Name21
object
2 properties 2 required
00158000006QBOhAAO1
object
3 properties 3 required
Value22
object
10 properties 7 required
ColumnWrap
object
6 properties 6 required
Fields41
object
7 properties 7 required
Records4
object
10 properties 10 required
Actions21
object
1 property 1 required
Photo
object
7 properties 7 required
Record11
object
20 properties 20 required
NamedCredential
object
6 properties 6 required
Owner
object
19 properties 19 required
GetListViewMetadatabyAPIName
object
18 properties 18 required
GetListViewRecordsbyID
object
16 properties 16 required
SuccessfulListExternalCredentials
object
1 property 1 required
Group
object
25 properties 25 required
Actions11
object
1 property 1 required
Alias4
object
2 properties 2 required
GetListViewRecordsperAPIName
object
16 properties 16 required
UserPreferences
object
2 properties 2 required
Actions15
object
1 property 1 required
Account18
object
3 properties 3 required
GetListViewMetadatabyID
object
19 properties 19 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
List
object
4 properties 4 required
GetListViewHeaderActions
object
3 properties 3 required
00158000006QBOhAAO2
object
3 properties 3 required
DisplayColumn
object
6 properties 6 required
MySubscription
object
2 properties 2 required
ExternalCredential
object
11 properties 11 required
RelatedNamedCredential
object
4 properties 4 required
BillingCountry3
object
2 properties 2 required
GetListViewRecordActions
object
3 properties 3 required
ListViewChartInstance
object
3 properties 3 required
GetRelatedListActions
object
3 properties 3 required
BannerPhoto
object
3 properties 3 required
GetMRUListViewActions
object
3 properties 3 required
Actions9
object
1 property 1 required
Type13
object
2 properties 2 required
GetListViewRecordsRequest
object
5 properties 5 required
OutOfOffice
object
1 property 1 required
SuccessfulListNamedCredentials
object
1 property 1 required
Actions8
object
19 properties 19 required
Actions10
object
19 properties 19 required
GetListViewChartActions
object
3 properties 3 required
OwnerId4
object
2 properties 2 required
Site2
object
2 properties 2 required
OrderedByInfo
object
3 properties 3 required
GetListViewRecords
object
16 properties 16 required
Listnamedcredentials
object
6 properties 6 required
Actions14
object
19 properties 19 required
Actions7
object
1 property 1 required
Actions13
object
1 property 1 required
SuccessfulListofGroups-POST
object
25 properties 25 required
Id8
object
2 properties 2 required
Attributes4
object
2 properties 2 required
GetRelatedListRecordActions
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

salesforce-lists-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 Lists 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.