Salesforce Record API

The Record API from Salesforce — 17 operation(s) for record.

Documentation

Specifications

Schemas & Data

OpenAPI Specification

salesforce-record-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Record 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: Record
paths:
  /data/v64.0/jobs/ingest//successfulResults:
    parameters: []
    get:
      tags:
      - Record
      summary: Salesforce Get Job Successful Record Results
      operationId: GetJobSuccessfulRecordResults
      parameters: []
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Mon, 20 Nov 2023 15:04:15 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-XSS-Protection:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: 1; mode=block
            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
            Sforce-Limit-Info:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: api-usage=12/15000
            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:
            text/csv:
              schema:
                type: string
                examples:
                - '"sf__Id","sf__Created",Name

                  '
                contentMediaType: text/csv
              example: '"sf__Id","sf__Created",Name

                '
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /data/v64.0/jobs/ingest//failedResults:
    parameters: []
    get:
      tags:
      - Record
      summary: Salesforce Get Job Failed Record Results
      operationId: GetJobFailedRecordResults
      parameters: []
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Mon, 20 Nov 2023 15:04:29 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-XSS-Protection:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: 1; mode=block
            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
            Sforce-Limit-Info:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: api-usage=12/15000
            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:
            text/csv:
              schema:
                type: string
                examples:
                - '"sf__Id","sf__Error",Name

                  '
                contentMediaType: text/csv
              example: '"sf__Id","sf__Error",Name

                '
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /data/v64.0/jobs/ingest//unprocessedrecords:
    parameters: []
    get:
      tags:
      - Record
      summary: Salesforce Get Job Unprocessed Record Results
      operationId: GetJobUnprocessedRecordResults
      parameters: []
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Mon, 20 Nov 2023 15:04:51 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-XSS-Protection:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: 1; mode=block
            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
            Sforce-Limit-Info:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: api-usage=15/15000
            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:
            text/csv:
              schema:
                type: string
                examples:
                - 'Name

                  '
                contentMediaType: text/csv
              example: 'Name

                '
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /data/v64.0/chatter/feeds/record/{RECORD_GROUP_ID}/feed-elements:
    parameters: []
    get:
      tags:
      - Record
      summary: Salesforce Record Feed Elements
      description: 'Returns the feed elements for all the records the context user is following, or all the feed elements of the specified recordId. Use this resource to search a feed or to get the feed elements for a specific feed, including another user’s feed. To use this resource to get the feed elements for a group, specify the group ID as the recordId.


        https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resource_feeds_record.htm'
      operationId: RecordFeedElements
      parameters:
      - name: RECORD_GROUP_ID
        in: path
        description: ''
        required: true
        schema:
          type: string
        example: '500123'
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Wed, 22 Nov 2023 11:05:44 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-XSS-Protection:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: 1; mode=block
            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/SuccessfulRecordFeedElements'
                - examples:
                  - currentPageToken: null
                    currentPageUrl: /services/data/v58.0/chatter/feeds/record/001.../feed-elements
                    elements: []
                    isModifiedToken: null
                    isModifiedUrl: null
                    nextPageToken: null
                    nextPageUrl: null
                    updatesToken: 2:1700651144000
                    updatesUrl: /services/data/v58.0/chatter/feeds/record/001.../feed-elements?updatedSince=2%3A1700651144000
                contentMediaType: application/json;charset=UTF-8
              example:
                currentPageToken: null
                currentPageUrl: /services/data/v58.0/chatter/feeds/record/001.../feed-elements
                elements: []
                isModifiedToken: null
                isModifiedUrl: null
                nextPageToken: null
                nextPageUrl: null
                updatesToken: 2:1700651144000
                updatesUrl: /services/data/v58.0/chatter/feeds/record/001.../feed-elements?updatedSince=2%3A1700651144000
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /data/v64.0/ui-api/actions/record/{RECORD_IDS}:
    parameters: []
    get:
      tags:
      - Record
      summary: Salesforce Get Record Detail Page Actions
      description: Get the actions on record detail pages.
      operationId: GetRecordDetailPageActions
      parameters:
      - name: RECORD_IDS
        in: path
        description: A single record ID, or a comma-delimited list of record IDs.
        required: true
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Fri, 06 Oct 2023 10:16:27 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
            ETag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: '"070a59ceff1430940937c233f1b952dd--gzip"'
            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/GetRecordDetailPageActions'
                - examples:
                  - actions:
                      0014H00002LbR7QQAV:
                        actions:
                        - actionListContext: Chatter
                          actionTarget: null
                          actionTargetType: Invoke
                          apiName: Follow
                          externalId: 00D58000000arpq:0014H00002LbR7QQAV::Chatter:Desktop:StandardButton:Follow
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/follow_120.png
                          id: 0JV4H0000328007WAA
                          isMassAction: 'false'
                          label: Follow
                          lwcComponent: null
                          primaryColor: 1B96FF
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: SingleActionLinks
                          sourceObject: 0014H00002LbR7QQAV
                          subtype: null
                          targetObject: Account
                          targetUrl: null
                          type: StandardButton
                        - actionListContext: Chatter
                          actionTarget: null
                          actionTargetType: null
                          apiName: FollowInStream
                          externalId: 00D58000000arpq:0014H00002LbR7QQAV::Chatter:Desktop:StandardButton:FollowInStream
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/follow_120.png
                          id: 0JV4H0000328008WAA
                          isMassAction: 'false'
                          label: Follow in Stream
                          lwcComponent: null
                          primaryColor: 1B96FF
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: SingleActionLinks
                          sourceObject: 0014H00002LbR7QQAV
                          subtype: null
                          targetObject: Account
                          targetUrl: null
                          type: StandardButton
                        - actionListContext: Record
                          actionTarget: /services/data/v58.0/quickActions/NewTask/describe
                          actionTargetType: Describe
                          apiName: Global.NewTask
                          externalId: 00D58000000arpq:0014H00002LbR7QQAV::Record:Desktop:09D58000002PE2f
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_task_120.png
                          id: 0JV4H0000328011WAA
                          isMassAction: 'false'
                          label: New Task
                          lwcComponent: null
                          primaryColor: 3BA755
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: ActivityComposer
                          sourceObject: 0014H00002LbR7QQAV
                          subtype: Create
                          targetObject: Task
                          targetUrl: null
                          type: QuickAction
                        - actionListContext: Record
                          actionTarget: /services/data/v58.0/quickActions/NewEvent/describe
                          actionTargetType: Describe
                          apiName: Global.NewEvent
                          externalId: 00D58000000arpq:0014H00002LbR7QQAV::Record:Desktop:09D58000002PE2j
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_event_120.png
                          id: 0JV4H0000328012WAA
                          isMassAction: 'false'
                          label: New Event
                          lwcComponent: null
                          primaryColor: FF538A
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: ActivityComposer
                          sourceObject: 0014H00002LbR7QQAV
                          subtype: Create
                          targetObject: Event
                          targetUrl: null
                          type: QuickAction
                        - actionListContext: Record
                          actionTarget: null
                          actionTargetType: null
                          apiName: FeedItem.TextPost
                          externalId: 00D58000000arpq:0014H00002LbR7QQAV::Record:Desktop:FeedItem.TextPost
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/share_post_120.png
                          id: 0JV4H0000328013WAA
                          isMassAction: 'false'
                          label: Post
                          lwcComponent: null
                          primaryColor: 1B96FF
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: CollaborateComposer
                          sourceObject: 0014H00002LbR7QQAV
                          subtype: Post
                          targetObject: null
                          targetUrl: null
                          type: QuickAction
                        - actionListContext: Record
                          actionTarget: null
                          actionTargetType: Invoke
                          apiName: Edit
                          externalId: 00D58000000arpq:0014H00002LbR7QQAV::Record:Desktop:StandardButton:Edit
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/edit_120.png
                          id: 0JV4H0000328014WAA
                          isMassAction: 'false'
                          label: Edit
                          lwcComponent: dxp_records:lwcEditActionHandler
                          primaryColor: 06A59A
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: Page
                          sourceObject: 0014H00002LbR7QQAV
                          subtype: ScreenAction
                          targetObject: Account
                          targetUrl: null
                          type: StandardButton
                        - actionListContext: Record
                          actionTarget: null
                          actionTargetType: null
                          apiName: FeedItem.ContentPost
                          externalId: 00D58000000arpq:0014H00002LbR7QQAV::Record:Desktop:FeedItem.ContentPost
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/share_file_120.png
                          id: 0JV4H0000328015WAA
                          isMassAction: 'false'
                          label: File
                          lwcComponent: null
                          primaryColor: '939393'
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: null
                          sourceObject: 0014H00002LbR7QQAV
                          subtype: Post
                          targetObject: null
                          targetUrl: null
                          type: QuickAction
                        - actionListContext: Record
                          actionTarget: /services/data/v58.0/quickActions/NewContact/describe
                          actionTargetType: Describe
                          apiName: Global.NewContact
                          externalId: 00D58000000arpq:0014H00002LbR7QQAV::Record:Desktop:09D58000002PE2k
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_contact_120.png
                          id: 0JV4H0000328016WAA
                          isMassAction: 'false'
                          label: New Contact
                          lwcComponent: null
                          primaryColor: 5867E8
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: Page
                          sourceObject: 0014H00002LbR7QQAV
                          subtype: Create
                          targetObject: Contact
                          targetUrl: null
                          type: QuickAction
                        - actionListContext: Record
                          actionTarget: /services/data/v58.0/quickActions/LogACall/describe
                          actionTargetType: Describe
                          apiName: Global.LogACall
                          externalId: 00D58000000arpq:0014H00002LbR7QQAV::Record:Desktop:09D58000002PE2g
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/log_a_call_120.png
                          id: 0JV4H0000328017WAA
                          isMassAction: 'false'
                          label: Log a Call
                          lwcComponent: null
                          primaryColor: 06A59A
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: ActivityComposer
                          sourceObject: 0014H00002LbR7QQAV
                          subtype: LogACall
                          targetObject: Task
                          targetUrl: null
                          type: QuickAction
                        - actionListContext: Record
                          actionTarget: /services/data/v58.0/quickActions/NewOpportunity/describe
                          actionTargetType: Describe
                          apiName: Global.NewOpportunity
                          externalId: 00D58000000arpq:0014H00002LbR7QQAV::Record:Desktop:09D58000002PE2l
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_opportunity_120.png
                          id: 0JV4H0000328018WAA
                          isMassAction: 'false'
                          label: New Opportunity
                          lwcComponent: null
                          primaryColor: FF5D2D
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: Page
                          sourceObject: 0014H00002LbR7QQAV
                          subtype: Create
                          targetObject: Opportunity
                          targetUrl: null
                          type: QuickAction
                        - actionListContext: Record
                          actionTarget: /services/data/v58.0/quickActions/NewCase/describe
                          actionTargetType: Describe
                          apiName: Global.NewCase
                          externalId: 00D58000000arpq:0014H00002LbR7QQAV::Record:Desktop:09D58000002PE2h
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_case_120.png
                          id: 0JV4H0000328019WAA
                          isMassAction: 'false'
                          label: New Case
                          lwcComponent: null
                          primaryColor: FF5D2D
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: Page
                          sourceObject: 0014H00002LbR7QQAV
                          subtype: Create
                          targetObject: Case
                          targetUrl: null
                          type: QuickAction
                        - actionListContext: Record
                          actionTarget: /services/data/v58.0/quickActions/NewLead/describe
                          actionTargetType: Describe
                          apiName: Global.NewLead
                          externalId: 00D58000000arpq:0014H00002LbR7QQAV::Record:Desktop:09D58000002PE2m
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_lead_120.png
                          id: 0JV4H0000328020WAA
                          isMassAction: 'false'
                          label: New Lead
                          lwcComponent: null
                          primaryColor: FF5D2D
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: Page
                          sourceObject: 0014H00002LbR7QQAV
                          subtype: Create
                          targetObject: Lead
                          targetUrl: null
                          type: QuickAction
                        - actionListContext: Record
                          actionTarget: null
                          actionTargetType: null
                          apiName: FeedItem.LinkPost
                          externalId: 00D58000000arpq:0014H00002LbR7QQAV::Record:Desktop:FeedItem.LinkPost
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/share_link_120.png
                          id: 0JV4H0000328021WAA
                          isMassAction: 'false'
                          label: Link
                          lwcComponent: null
                          primaryColor: 1B96FF
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: null
                          sourceObject: 0014H00002LbR7QQAV
                          subtype: Post
                          targetObject: null
                          targetUrl: null
                          type: QuickAction
                        - actionListContext: Record
                          actionTarget: null
                          actionTargetType: null
                          apiName: FeedItem.PollPost
                          externalId: 00D58000000arpq:0014H00002LbR7QQAV::Record:Desktop:FeedItem.PollPost
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/share_poll_120.png
                          id: 0JV4H0000328022WAA
                          isMassAction: 'false'
                          label: Poll
                          lwcComponent: null
                 

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