Salesforce

Salesforce Records API

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

GitHub OpenAPI

Documentation

📖
Documentation
https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/
📖
APIReference
https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/get_job_info.htm
📖
Authentication
https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/bulk_api_2_0_security.htm
📖
Documentation
https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/
📖
GettingStarted
https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started.htm
📖
APIReference
https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list.htm
📖
Documentation
https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/rest-api.html
📖
GettingStarted
https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/get-started-spec.html
📖
APIReference
https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_overview.html
📖
Authentication
https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/access-token-s2s.html
📖
Documentation
https://developer.salesforce.com/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/salesforce/refs/heads/main/openapi/salesforce-records-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/salesforce/refs/heads/main/json-schema/salesforce-bulk-job-schema.json

OpenAPI Specification

salesforce-records-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Records API
  description: 'Salesforce Bulk API 2.0 is a simplified, REST-based interface for bulk data operations that improves on the original Bulk API. It uses a straightforward job model and supports CSV format for ingest and query jobs, enabling processing of millions of records asynchronously.

    '
  version: v63.0
  contact:
    name: Salesforce Developers
    url: https://developer.salesforce.com/
  license:
    name: Salesforce Developer Terms
    url: https://www.salesforce.com/company/legal/agreements/
servers:
- url: https://{instance}.salesforce.com/services/data/v{version}/jobs
  description: Salesforce Bulk API 2.0 jobs endpoint
  variables:
    instance:
      default: yourInstance
      description: 'The Salesforce instance identifier (e.g., na1, eu3, or a My Domain subdomain like mycompany).

        '
    version:
      default: '63.0'
      description: 'The Salesforce API version number (e.g., 63.0). Use the latest supported version for new integrations.

        '
security:
- BearerAuth: []
tags:
- name: Records
paths:
  /data/v64.0/ui-api/list-records/{LIST_VIEW_ID}:
    parameters: []
    get:
      tags:
      - Records
      summary: Salesforce Get List View Records by Id
      description: Get record data for a list view by list view ID using URL parameters.
      operationId: GetListViewRecordsbyID
      parameters:
      - name: LIST_VIEW_ID
        in: path
        description: The ID of a list view.
        required: true
        schema:
          type: string
        example: '500123'
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Fri, 06 Oct 2023 09:52:06 GMT
            Strict-Transport-Security:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: max-age=63072000; includeSubDomains
            X-Content-Type-Options:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: nosniff
            X-Robots-Tag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: none
            Cache-Control:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: no-cache,must-revalidate,max-age=0,no-store,private
            Vary:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Accept-Encoding
            Content-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: gzip
            Transfer-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: chunked
          content:
            application/json;charset=UTF-8:
              schema:
                allOf:
                - $ref: '#/components/schemas/GetListViewRecordsbyID'
                - examples:
                  - count: 50
                    currentPageToken: '0'
                    currentPageUrl: /services/data/v62.0/ui-api/list-records/00B58000002ssinEAA?pageSize=50&pageToken=0
                    fields: []
                    listInfoETag: 55ebdd0de6c2f1e17f63bf4581d64f76
                    listReference:
                      id: 00B58000002ssinEAA
                      listViewApiName: AllAccounts
                      objectApiName: Account
                      type: listView
                    nextPageToken: '50'
                    nextPageUrl: /services/data/v62.0/ui-api/list-records/00B58000002ssinEAA?pageSize=50&pageToken=50
                    optionalFields: []
                    pageSize: 50
                    previousPageToken: null
                    previousPageUrl: null
                    records:
                    - apiName: Account
                      childRelationships: {}
                      eTag: c7b296e1aa5fa482e1f77e8dc0e0b5e1
                      fields:
                        BillingCountry:
                          displayValue: null
                          value: USA
                        CreatedDate:
                          displayValue: null
                          value: '2020-02-27T09:28:06.000Z'
                        Id:
                          displayValue: null
                          value: 0014H00002LbR7QQAV
                        LastModifiedById:
                          displayValue: null
                          value: 00558000000yFyDAAU
                        LastModifiedDate:
                          displayValue: null
                          value: '2023-10-04T18:35:13.000Z'
                        Name:
                          displayValue: null
                          value: ABC Computing
                        Owner:
                          displayValue: Philippe Ozil
                          value:
                            apiName: User
                            childRelationships: {}
                            eTag: cd72f37056763253524392799303114f
                            fields:
                              Alias:
                                displayValue: null
                                value: POzil
                              CreatedDate:
                                displayValue: null
                                value: '2016-05-09T13:51:39.000Z'
                              Id:
                                displayValue: null
                                value: 00558000000yFyDAAU
                              LastModifiedById:
                                displayValue: null
                                value: 00558000000yFyDAAU
                              LastModifiedDate:
                                displayValue: null
                                value: '2023-10-06T08:34:22.000Z'
                              Name:
                                displayValue: null
                                value: Philippe Ozil
                              SystemModstamp:
                                displayValue: null
                                value: '2023-10-06T08:34:22.000Z'
                            id: 00558000000yFyDAAU
                            lastModifiedById: 00558000000yFyDAAU
                            lastModifiedDate: '2023-10-06T08:34:22.000Z'
                            recordTypeId: null
                            recordTypeInfo: null
                            systemModstamp: '2023-10-06T08:34:22.000Z'
                        OwnerId:
                          displayValue: null
                          value: 00558000000yFyDAAU
                        Phone:
                          displayValue: null
                          value: '123123123'
                        Site:
                          displayValue: null
                          value: null
                        SystemModstamp:
                          displayValue: null
                          value: '2023-10-04T18:35:13.000Z'
                        Type:
                          displayValue: null
                          value: null
                      id: 0014H00002LbR7QQAV
                      lastModifiedById: 00558000000yFyDAAU
                      lastModifiedDate: '2023-10-04T18:35:13.000Z'
                      recordTypeId: 012000000000000AAA
                      recordTypeInfo: null
                      systemModstamp: '2023-10-04T18:35:13.000Z'
                    - apiName: Account
                      childRelationships: {}
                      eTag: cfeff90a24208129b7cf7be4e47dda99
                      fields:
                        BillingCountry:
                          displayValue: null
                          value: USA
                        CreatedDate:
                          displayValue: null
                          value: '2016-05-09T13:51:39.000Z'
                        Id:
                          displayValue: null
                          value: 00158000006QBOhAAO
                        LastModifiedById:
                          displayValue: null
                          value: 00558000000yFyDAAU
                        LastModifiedDate:
                          displayValue: null
                          value: '2020-09-29T16:04:02.000Z'
                        Name:
                          displayValue: null
                          value: Burlington Textiles Corp of America
                        Owner:
                          displayValue: Philippe Ozil
                          value:
                            apiName: User
                            childRelationships: {}
                            eTag: cd72f37056763253524392799303114f
                            fields:
                              Alias:
                                displayValue: null
                                value: POzil
                              CreatedDate:
                                displayValue: null
                                value: '2016-05-09T13:51:39.000Z'
                              Id:
                                displayValue: null
                                value: 00558000000yFyDAAU
                              LastModifiedById:
                                displayValue: null
                                value: 00558000000yFyDAAU
                              LastModifiedDate:
                                displayValue: null
                                value: '2023-10-06T08:34:22.000Z'
                              Name:
                                displayValue: null
                                value: Philippe Ozil
                              SystemModstamp:
                                displayValue: null
                                value: '2023-10-06T08:34:22.000Z'
                            id: 00558000000yFyDAAU
                            lastModifiedById: 00558000000yFyDAAU
                            lastModifiedDate: '2023-10-06T08:34:22.000Z'
                            recordTypeId: null
                            recordTypeInfo: null
                            systemModstamp: '2023-10-06T08:34:22.000Z'
                        OwnerId:
                          displayValue: null
                          value: 00558000000yFyDAAU
                        Phone:
                          displayValue: null
                          value: (336) 222-7000
                        Site:
                          displayValue: null
                          value: null
                        SystemModstamp:
                          displayValue: null
                          value: '2020-09-29T16:04:02.000Z'
                        Type:
                          displayValue: Customer
                          value: Customer
                      id: 00158000006QBOhAAO
                      lastModifiedById: 00558000000yFyDAAU
                      lastModifiedDate: '2020-09-29T16:04:02.000Z'
                      recordTypeId: 012000000000000AAA
                      recordTypeInfo: null
                      systemModstamp: '2020-09-29T16:04:02.000Z'
                    - apiName: Account
                      childRelationships: {}
                      eTag: c42c5257506520c737965101b225840c
                      fields:
                        BillingCountry:
                          displayValue: null
                          value: USA
                        CreatedDate:
                          displayValue: null
                          value: '2016-05-09T13:51:39.000Z'
                        Id:
                          displayValue: null
                          value: 00158000006QBOjAAO
                        LastModifiedById:
                          displayValue: null
                          value: 00558000000yFyDAAU
                        LastModifiedDate:
                          displayValue: null
                          value: '2020-09-29T15:52:06.000Z'
                        Name:
                          displayValue: null
                          value: Dickenson Co.
                        Owner:
                          displayValue: Philippe Ozil
                          value:
                            apiName: User
                            childRelationships: {}
                            eTag: cd72f37056763253524392799303114f
                            fields:
                              Alias:
                                displayValue: null
                                value: POzil
                              CreatedDate:
                                displayValue: null
                                value: '2016-05-09T13:51:39.000Z'
                              Id:
                                displayValue: null
                                value: 00558000000yFyDAAU
                              LastModifiedById:
                                displayValue: null
                                value: 00558000000yFyDAAU
                              LastModifiedDate:
                                displayValue: null
                                value: '2023-10-06T08:34:22.000Z'
                              Name:
                                displayValue: null
                                value: Philippe Ozil
                              SystemModstamp:
                                displayValue: null
                                value: '2023-10-06T08:34:22.000Z'
                            id: 00558000000yFyDAAU
                            lastModifiedById: 00558000000yFyDAAU
                            lastModifiedDate: '2023-10-06T08:34:22.000Z'
                            recordTypeId: null
                            recordTypeInfo: null
                            systemModstamp: '2023-10-06T08:34:22.000Z'
                        OwnerId:
                          displayValue: null
                          value: 00558000000yFyDAAU
                        Phone:
                          displayValue: null
                          value: (785) 241-6200
                        Site:
                          displayValue: null
                          value: null
                        SystemModstamp:
                          displayValue: null
                          value: '2020-09-29T15:52:06.000Z'
                        Type:
                          displayValue: Customer
                          value: Customer
                      id: 00158000006QBOjAAO
                      lastModifiedById: 00558000000yFyDAAU
                      lastModifiedDate: '2020-09-29T15:52:06.000Z'
                      recordTypeId: 012000000000000AAA
                      recordTypeInfo: null
                      systemModstamp: '2020-09-29T15:52:06.000Z'
                    - apiName: Account
                      childRelationships: {}
                      eTag: 2f21e61d45d05263809593342f5761f4
                      fields:
                        BillingCountry:
                          displayValue: null
                          value: France
                        CreatedDate:
                          displayValue: null
                          value: '2016-05-09T13:51:39.000Z'
                        Id:
                          displayValue: null
                          value: 00158000006QBOiAAO
                        LastModifiedById:
                          displayValue: null
                          value: 00558000000yFyDAAU
                        LastModifiedDate:
                          displayValue: null
                          value: '2016-05-11T08:48:05.000Z'
                        Name:
                          displayValue: null
                          value: Pyramid Construction Inc.
                        Owner:
                          displayValue: Philippe Ozil
                          value:
                            apiName: User
                            childRelationships: {}
                            eTag: cd72f37056763253524392799303114f
                            fields:
                              Alias:
                                displayValue: null
                                value: POzil
                              CreatedDate:
                                displayValue: null
                                value: '2016-05-09T13:51:39.000Z'
                              Id:
                                displayValue: null
                                value: 00558000000yFyDAAU
                              LastModifiedById:
                                displayValue: null
                                value: 00558000000yFyDAAU
                              LastModifiedDate:
                                displayValue: null
                                value: '2023-10-06T08:34:22.000Z'
                              Name:
                                displayValue: null
                                value: Philippe Ozil
                              SystemModstamp:
                                displayValue: null
                                value: '2023-10-06T08:34:22.000Z'
                            id: 00558000000yFyDAAU
                            lastModifiedById: 00558000000yFyDAAU
                            lastModifiedDate: '2023-10-06T08:34:22.000Z'
                            recordTypeId: null
                            recordTypeInfo: null
                            systemModstamp: '2023-10-06T08:34:22.000Z'
                        OwnerId:
                          displayValue: null
                          value: 00558000000yFyDAAU
                        Phone:
                          displayValue: null
                          value: (014) 427-4427
                        Site:
                          displayValue: null
                          value: null
                        SystemModstamp:
                          displayValue: null
                          value: '2016-05-11T08:48:05.000Z'
                        Type:
                          displayValue: Customer
                          value: Customer
                      id: 00158000006QBOiAAO
                      lastModifiedById: 00558000000yFyDAAU
                      lastModifiedDate: '2016-05-11T08:48:05.000Z'
                      recordTypeId: 012000000000000AAA
                      recordTypeInfo: null
                      systemModstamp: '2016-05-11T08:48:05.000Z'
                    - apiName: Account
                      childRelationships: {}
                      eTag: a5b391b1caf935de4bbc96858a4e6a12
                      fields:
                        BillingCountry:
                          displayValue: null
                          value: null
                        CreatedDate:
                          displayValue: null
                          value: '2020-02-04T18:26:08.000Z'
                        Id:
                          displayValue: null
                          value: 0014H00002E6wi6QAB
                        LastModifiedById:
                          displayValue: null
                          value: 00558000000yFyDAAU
                        LastModifiedDate:
                          displayValue: null
                          value: '2020-02-04T18:26:08.000Z'
                        Name:
                          displayValue: null
                          value: Sample Account
                        Owner:
                          displayValue: Philippe Ozil
                          value:
                            apiName: User
                            childRelationships: {}
                            eTag: cd72f37056763253524392799303114f
                            fields:
                              Alias:
                                displayValue: null
                                value: POzil
                              CreatedDate:
                                displayValue: null
                                value: '2016-05-09T13:51:39.000Z'
                              Id:
                                displayValue: null
                                value: 00558000000yFyDAAU
                              LastModifiedById:
                                displayValue: null
                                value: 00558000000yFyDAAU
                              LastModifiedDate:
                                displayValue: null
                                value: '2023-10-06T08:34:22.000Z'
                              Name:
                                displayValue: null
                                value: Philippe Ozil
                              SystemModstamp:
                                displayValue: null
                                value: '2023-10-06T08:34:22.000Z'
                            id: 00558000000yFyDAAU
                            lastModifiedById: 00558000000yFyDAAU
                            lastModifiedDate: '2023-10-06T08:34:22.000Z'
                            recordTypeId: null
                            recordTypeInfo: null
                            systemModstamp: '2023-10-06T08:34:22.000Z'
                        OwnerId:
                          displayValue: null
                          value: 00558000000yFyDAAU
                        Phone:
                          displayValue: null
                          value: null
                        Site:
                          displayValue: null
                          value: null
                        SystemModstamp:
                          displayValue: null
                          value: '2020-02-04T18:26:08.000Z'
                        Type:
                          displayValue: null
                          value: null
                      id: 0014H00002E6wi6QAB
                      lastModifiedById: 00558000000yFyDAAU
                      lastModifiedDate: '2020-02-04T18:26:08.000Z'
                      recordTypeId: 012000000000000AAA
                      recordTypeInfo: null
                      systemModstamp: '2020-02-04T18:26:08.000Z'
                    - apiName: Account
                      childRelationships: {}
                      eTag: fe60d8fe25895ac63644cf563fdc35d6
                      fields:
                        BillingCountry:
                          displayValue: null
                          value: null
                        CreatedDate:
                          displayValue: null
                          value: '2021-02-02T13:47:39.000Z'
                        Id:
                          displayValue: null
                          value: 0014H00002x6HUhQAM
                        LastModifiedById:
                          displayValue: null
                          value: 00558000000yFyDAAU
                        LastModifiedDate:
                          displayValue: null
                          value: '2021-02-25T09:30:33.000Z'
                        Name:
                          displayValue: null
                          value: ACME Inc.
                        Owner:
                          displayValue: Philippe Ozil
                          value:
                            apiName: User
                            childRelationships: {}
                            eTag: cd72f37056763253524392799303114f
                            fields:
                              Alias:
                                displayValue: null
                                value: POzil
                              CreatedDate:
                                displayValue: null
                                value: '2016-05-09T13:51:39.000Z'
                              Id:
                                displayValue: null
                                value: 00558000000yFyDAAU
                              LastModifiedById:
                                displayValue: null
                                value: 00558000000yFyDAAU
                              LastModifiedDate:
                                displayValue: null
                                value: '2023-10-06T08:34:22.000Z'
                              Name:
                                displayValue: null
                                value: Philippe Ozil
                              SystemModstamp:
                                displayValue: null
                                value: '2023-10-06T08:34:22.000Z'
                            id: 00558000000yFyDAAU
                            lastModifiedById: 00558000000yFyDAAU
                            lastModifiedDate: '2023-10-06T08:34:22.000Z'
                            recordTypeId: null
                            recordTypeInfo: null
                            systemModstamp: '2023-10-06T08:34:22.000Z'
                        OwnerId:
                          displayValue: null
                          value: 00558000000yFyDAAU
                        Phone:
                          displayValue: null
                          value: null
                        Site:
                          displayValue: null
                          value: null
                        SystemModstamp:
                          displayValue: null
                          value: '2021-02-25T09:30:33.000Z'
                        Type:
                          displayValue: null
                          value: null
                      id: 0014H00002x6HUhQAM
                      lastModifiedById: 00558000000yFyDAAU
                      lastModifiedDate: '2021-02-25T09:30:33.000Z'
                      recordTypeId: 012000000000000AAA
                      recordTypeInfo: null
                      systemModstamp: '2021-02-25T09:30:33.000Z'
                    - apiName: Account
                      childRelationships: {}
                      eTag: 3e85e3f4d6851dd2922333dcec928b1e
                      fields:
                        BillingCountry:
                          displayValue: null
                          value: null
                        CreatedDate:
                          displayValue: null
                          value: '2023-04-25T16:02:10.000Z'
                        Id:
                          displayValue: null
                          value: 0014H00004CXfY8QAL
                        LastModifiedById:
                          displayValue: null
                          value: 00558000000yFyDAAU
                        LastModifiedDate:
                          displayValue: null
                          value: '2023-04-25T16:02:10.000Z'
                        Name:
                          displayValue: null
                          value: test
                        Owner:
                          displayValue: Philippe Ozil
                          value:
                            apiName: User
                            childRelationships: {}
                            eTag: cd72f37056763253524392799303114f
                            fields:
                              Alias:
                                displayValue: null
                                value: POzil
                              CreatedDate:
                                displayValue: null
                                value: '2016-05-09T13:51:39.000Z'
                              Id:
                                displayValue: null
                                value: 00558000000yFyDAAU
                              LastModifiedById:
                                displayValue: null
                                value: 00558000000yFyDAAU
                              LastModifiedDate:
                                displayValue: null
                                value: '2023-10-06T08:34:22.000Z'
                              Name:
                                displayValue: null
                                value: Philippe Ozil
                              SystemModstamp:
                                displayValue: null
                                value: '2023-10-06T08:34:22.000Z'
                            id: 00558000000yFyDAAU
                            lastModifiedById: 00558000000yFyDAAU
                            lastModifiedDate: '2023-10-06T08:34:22.000Z'
                            recordTypeId: null
                            recordTypeInfo: null
                            systemModstamp: '2023-10-06T08:34:22.000Z'
                        OwnerId:
                          displayValue: null
                          value: 00558000000yFyDAAU
                        Phone:
                          displayValue: null
                          value: null
                        Site:
                          displayValue: null
                          value: null
                        SystemModstamp:
                          displayValue: null
                          value: '2023-04-25T16:02:10.000Z'
                        Type:
                          displayValue: null
                          value: null
                      id: 0014H00004CXfY8QAL
                      lastModifiedById: 00558000000yFyDAAU
                      lastModifiedDate: '2023-04-25T16:02:10.000Z'
                      recordTypeId: 012000000000000AAA
                      recordTypeInfo: null
                      systemModstamp: '2023-04-25T16:02:10.000Z'
                    - apiName: Account
                      childRelationships: {}
                      eTag: d33080f9749c8d05a6b936a01419362e
                      fields:
                        BillingCountry:
                          displayValue: null
                          value: null
                        CreatedDate:
                          displayValue: null
                          value: '2023-09-13T22:04:24.000Z'
                        Id:
                          displayValue: null
                          value: 0014H00004GXwPnQAL
                        LastModifiedById:
                          displayValue: null
                          value: 00558000000yFyDAAU
                        LastModifiedDate:
                          displayValue: null
                          value: '2023-09-13T22:04:24.000Z'
                        Name:
                          displayValue: null
                          value: test
                        Owner:
                          displayValue: Philippe Ozil
                          value:
                            apiName: User
                            childRelationships: {}
                            eTag: cd72f37056763253524392799303114f
                            fields:
                              Alias:
                                displayValue: null
                                value: POzil
                              CreatedDate:
                                displayValue: null
                                value: '2016-05-09T13:51:39.000Z'
                              Id:
                                displayValue: null
                                value: 00558000000yFyDAAU
                              LastModifiedById:
                                displayValue: null
                                value: 00558000000yFyDAAU
                              LastModifiedDate:
                                displayValue: null
                                value: '2023-10-06T08:34:22.000Z'
                              Name:
                                displayValue: null
                                value: Philippe Ozil
                              SystemModstamp:
                                displayValue: null
                                value: '2023-10-06T08:34:22.000Z'
                            id: 00558000000yFyDAAU
                            lastModifiedById: 00558000000yFyDAAU
                            lastModifiedDate: '2023-

# --- truncated at 32 KB (1558 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/salesforce/refs/heads/main/openapi/salesforce-records-api-openapi.yml