Salesforce Items API

openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Items 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: Items
paths:
  /data/v64.0/chatter/feed-elements/{FEED_ELEMENT_ID}/capabilities/comments/items:
    parameters: []
    post:
      tags:
      - Items
      summary: Salesforce Feed Elements Capability, Comments Items
      description: 'Access comments for a feed element, or add a comment to a feed element.

        To upload a binary file to attach to a comment, you must send it in a multipart/form-data request. To send the text of the comment, you can choose to include a JSON or XML rich input body part in the multipart/form-data request. Alternately, you can choose to pass the information in request parameter parts. For information about how to create the multipart/form-data message, see Uploading Binary Files.


        https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_feed_element_capability_comments_items.htm#connect_resources_feed_element_capability_comments_items'
      operationId: FeedElementsCapability,CommentsItems
      parameters:
      - name: text
        in: query
        description: ''
        required: true
        style: form
        explode: true
        schema:
          type: string
          examples:
          - New Comment
        example: example_value
      - name: FEED_ELEMENT_ID
        in: path
        description: ''
        required: true
        schema:
          type: string
        example: '500123'
      responses:
        '201':
          description: Created
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Wed, 22 Nov 2023 11:14:33 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/FeedElementsCapabilityCommentsItems'
                - examples:
                  - body:
                      isRichText: false
                      messageSegments:
                      - text: New Comment
                        type: Text
                      text: New Comment
                    capabilities:
                      edit:
                        isEditRestricted: false
                        isEditableByMeUrl: /services/data/v58.0/chatter/comments/0D7.../capabilities/edit/is-editable-by-me
                        lastEditedBy: null
                        lastEditedDate: null
                        latestRevision: 1
                        relativeLastEditedDate: null
                      status:
                        feedEntityStatus: Published
                        isApprovableByMe: true
                      upDownVote:
                        downVoteCount: 0
                        myVote: None
                        upVoteCount: 0
                      verified:
                        isVerifiableByMe: false
                        isVerified: false
                        isVerifiedByAnonymized: null
                        lastVerifiedByUser: null
                        lastVerifiedDate: null
                    clientInfo:
                      applicationName: Postman Playground
                      applicationUrl: null
                    createdDate: '2023-11-22T11:14:33.000Z'
                    feedElement:
                      id: 0D5...
                      url: /services/data/v58.0/chatter/feed-elements/0D5...
                    id: 0D7...
                    isDeleteRestricted: false
                    likes:
                      currentPageToken: null
                      currentPageUrl: /services/data/v58.0/chatter/comments/0D7.../likes
                      items: []
                      nextPageToken: null
                      nextPageUrl: null
                      previousPageToken: null
                      previousPageUrl: null
                      total: 0
                    likesMessage: null
                    moderationFlags: null
                    myLike: null
                    parent:
                      id: 001...
                      url: /services/data/v58.0/chatter/records/001...
                    relativeCreatedDate: Just now
                    threadLevel: 0
                    threadParentId: null
                    type: TextComment
                    url: /services/data/v58.0/chatter/comments/0D7...
                    user:
                      additionalLabel: null
                      communityNickname: User1696423780773910041
                      companyName: Salesforce
                      displayName: Name
                      firstName: Firstname
                      id: 005...
                      isActive: true
                      isInThisCommunity: true
                      lastName: Name
                      motif:
                        color: 1B96FF
                        largeIconUrl: /img/icon/profile64.png
                        mediumIconUrl: /img/icon/profile32.png
                        smallIconUrl: /img/icon/profile16.png
                        svgIconUrl: null
                      mySubscription: null
                      name: Name
                      outOfOffice:
                        message: ''
                      photo:
                        fullEmailPhotoUrl: https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1
                        largePhotoUrl: https://<my_domain>/profilephoto/729.../F
                        mediumPhotoUrl: https://<my_domain>/profilephoto/729.../M
                        photoVersionId: 729...
                        smallPhotoUrl: https://<my_domain>/profilephoto/729.../T
                        standardEmailPhotoUrl: https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1
                        url: /services/data/v58.0/connect/user-profiles/005.../photo
                      reputation: null
                      title: null
                      type: User
                      url: /services/data/v58.0/chatter/users/005...
                      userType: Internal
                contentMediaType: application/json;charset=UTF-8
              example:
                body:
                  isRichText: false
                  messageSegments:
                  - text: New Comment
                    type: Text
                  text: New Comment
                capabilities:
                  edit:
                    isEditRestricted: false
                    isEditableByMeUrl: /services/data/v58.0/chatter/comments/0D7.../capabilities/edit/is-editable-by-me
                    lastEditedBy: null
                    lastEditedDate: null
                    latestRevision: 1
                    relativeLastEditedDate: null
                  status:
                    feedEntityStatus: Published
                    isApprovableByMe: true
                  upDownVote:
                    downVoteCount: 0
                    myVote: None
                    upVoteCount: 0
                  verified:
                    isVerifiableByMe: false
                    isVerified: false
                    isVerifiedByAnonymized: null
                    lastVerifiedByUser: null
                    lastVerifiedDate: null
                clientInfo:
                  applicationName: Postman Playground
                  applicationUrl: null
                createdDate: '2023-11-22T11:14:33.000Z'
                feedElement:
                  id: 0D5...
                  url: /services/data/v58.0/chatter/feed-elements/0D5...
                id: 0D7...
                isDeleteRestricted: false
                likes:
                  currentPageToken: null
                  currentPageUrl: /services/data/v58.0/chatter/comments/0D7.../likes
                  items: []
                  nextPageToken: null
                  nextPageUrl: null
                  previousPageToken: null
                  previousPageUrl: null
                  total: 0
                likesMessage: null
                moderationFlags: null
                myLike: null
                parent:
                  id: 001...
                  url: /services/data/v58.0/chatter/records/001...
                relativeCreatedDate: Just now
                threadLevel: 0
                threadParentId: null
                type: TextComment
                url: /services/data/v58.0/chatter/comments/0D7...
                user:
                  additionalLabel: null
                  communityNickname: User1696423780773910041
                  companyName: Salesforce
                  displayName: Name
                  firstName: Firstname
                  id: 005...
                  isActive: true
                  isInThisCommunity: true
                  lastName: Name
                  motif:
                    color: 1B96FF
                    largeIconUrl: /img/icon/profile64.png
                    mediumIconUrl: /img/icon/profile32.png
                    smallIconUrl: /img/icon/profile16.png
                    svgIconUrl: null
                  mySubscription: null
                  name: Name
                  outOfOffice:
                    message: ''
                  photo:
                    fullEmailPhotoUrl: https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1
                    largePhotoUrl: https://<my_domain>/profilephoto/729.../F
                    mediumPhotoUrl: https://<my_domain>/profilephoto/729.../M
                    photoVersionId: 729...
                    smallPhotoUrl: https://<my_domain>/profilephoto/729.../T
                    standardEmailPhotoUrl: https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1
                    url: /services/data/v58.0/connect/user-profiles/005.../photo
                  reputation: null
                  title: null
                  type: User
                  url: /services/data/v58.0/chatter/users/005...
                  userType: Internal
      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/query:
    parameters: []
    get:
      tags:
      - Items
      summary: Salesforce List Event Relay Feedback Items
      operationId: Listeventrelayfeedbackitems
      parameters:
      - name: q
        in: query
        description: ''
        required: true
        style: form
        explode: true
        schema:
          type: string
          examples:
          - SELECT FIELDS(ALL) FROM EventRelayFeedback LIMIT 200
        example: example_value
      responses:
        '200':
          description: ''
          headers: {}
      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/sobjects/{SOBJECT_API_NAME}/listviews/recent:
    parameters: []
    get:
      tags:
      - Items
      summary: Salesforce Recently Viewed Items
      description: 'Gets the most recently accessed items that were viewed or referenced by the current user. Salesforce stores information about record views in the interface and uses it to generate a list of recently viewed and referenced records, such as in the sidebar and for the auto-complete options in search.


        This resource only accesses most recently used item information. If you want to modify the list of recently viewed items, you’ll need to update recently viewed information directly by using a SOQL Query with a FOR VIEW or FOR REFERENCE clause.

        https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_recent_items.htm'
      operationId: RecentlyViewedItems
      parameters:
      - name: limit
        in: query
        description: ''
        required: true
        style: form
        explode: true
        schema:
          type: string
        example: example_value
      - name: SOBJECT_API_NAME
        in: path
        description: ''
        required: true
        schema:
          type: string
        example: example_value
      - name: Content-Type
        in: header
        description: ''
        required: true
        schema:
          const: application/json
          type: string
          examples:
          - application/json
        example: example_value
      responses:
        '200':
          description: ''
          headers: {}
      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/sobjects/relevantItems:
    parameters: []
    get:
      tags:
      - Items
      summary: Salesforce Relevant Items
      description: 'Gets the current user’s most relevant items. Relevant items include records for objects in the user’s global search scope and also most recently used (MRU) objects.

        Relevant items include up to 50 of the most recently viewed or updated records for each object in the user’s global search scope.

        Note

        The user’s global search scope includes the objects the user interacted with most in the last 30 days, including objects the user pinned from the search results page in the Salesforce Classic.


        Then, the resource finds more recent records for each most recently used (MRU) object until the maximum number of records, which is 2,000, is returned.

        This resource only accesses the relevant item information. Modifying the list of relevant items is not currently supported

        https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_relevant_items.htm'
      operationId: RelevantItems
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        schema:
          const: application/json
          type: string
          examples:
          - application/json
        example: example_value
      responses:
        '200':
          description: ''
          headers: {}
      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/apps/{APP_ID}/user-nav-items:
    parameters: []
    get:
      tags:
      - Items
      summary: Salesforce Get Personalized Navigation Items
      description: Get a user’s personalized navigation items (tabs).
      operationId: GetPersonalizedNavigationItems
      parameters:
      - name: APP_ID
        in: path
        description: Application ID
        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:42:05 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: '"0d35dc3820e3022bcf9145fc3ec5be69--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/Resultwithpersonalizednav'
                - examples:
                  - currentPageUrl: /services/data/v58.0/ui-api/apps/06m58000000fBK2AAM/user-nav-items?formFactor=large
                    eTag: 0d35dc3820e3022bcf9145fc3ec5be69
                    navItems:
                    - availableInClassic: true
                      availableInLightning: true
                      color: FF538A
                      content: https://pozil-dev-ed.my.salesforce.com/lightning/page/home
                      custom: false
                      developerName: standard-home
                      iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/home_120.png
                      id: 0Qk4H0000009kokSAA
                      itemType: Standard
                      label: Home
                      objectApiName: Home
                      objectLabel: null
                      objectLabelPlural: null
                      pageReference:
                        attributes:
                          pageName: home
                        state: {}
                        type: standard__namedPage
                      standardType: Home
                    - availableInClassic: true
                      availableInLightning: true
                      color: FF5D2D
                      content: https://pozil-dev-ed.my.salesforce.com/006/o
                      custom: false
                      developerName: standard-Opportunity
                      iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/opportunity_120.png
                      id: 0Qk4H0000009kolSAA
                      itemType: Entity
                      label: Opportunities
                      objectApiName: Opportunity
                      objectLabel: Opportunity
                      objectLabelPlural: Opportunities
                      pageReference:
                        attributes:
                          objectApiName: Opportunity
                          actionName: home
                        state: {}
                        type: standard__objectPage
                      standardType: null
                    - availableInClassic: true
                      availableInLightning: true
                      color: FF5D2D
                      content: https://pozil-dev-ed.my.salesforce.com/00Q/o
                      custom: false
                      developerName: standard-Lead
                      iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/lead_120.png
                      id: 0Qk4H0000009komSAA
                      itemType: Entity
                      label: Leads
                      objectApiName: Lead
                      objectLabel: Lead
                      objectLabelPlural: Leads
                      pageReference:
                        attributes:
                          objectApiName: Lead
                          actionName: home
                        state: {}
                        type: standard__objectPage
                      standardType: null
                    - availableInClassic: false
                      availableInLightning: true
                      color: 3BA755
                      content: https://pozil-dev-ed.my.salesforce.com/00T/o
                      custom: false
                      developerName: standard-Task
                      iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/task_120.png
                      id: 0Qk4H0000009konSAA
                      itemType: Standard
                      label: Tasks
                      objectApiName: Task
                      objectLabel: Task
                      objectLabelPlural: Tasks
                      pageReference:
                        attributes:
                          objectApiName: Task
                          actionName: home
                        state: {}
                        type: standard__objectPage
                      standardType: Tasks
                    - availableInClassic: true
                      availableInLightning: true
                      color: '939393'
                      content: https://pozil-dev-ed.my.salesforce.com/_ui/core/chatter/files/FileTabPage
                      custom: false
                      developerName: standard-File
                      iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/file_120.png
                      id: 0Qk4H0000009kooSAA
                      itemType: Entity
                      label: Files
                      objectApiName: ContentDocument
                      objectLabel: null
                      objectLabelPlural: null
                      pageReference:
                        attributes:
                          objectApiName: ContentDocument
                          actionName: home
                        state: {}
                        type: standard__objectPage
                      standardType: null
                    - availableInClassic: true
                      availableInLightning: true
                      color: 5867E8
                      content: https://pozil-dev-ed.my.salesforce.com/001/o
                      custom: false
                      developerName: standard-Account
                      iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_120.png
                      id: 0Qk4H0000009kopSAA
                      itemType: Entity
                      label: Accounts
                      objectApiName: Account
                      objectLabel: Account
                      objectLabelPlural: Accounts
                      pageReference:
                        attributes:
                          objectApiName: Account
                          actionName: home
                        state: {}
                        type: standard__objectPage
                      standardType: null
                    - availableInClassic: true
                      availableInLightning: true
                      color: 5867E8
                      content: https://pozil-dev-ed.my.salesforce.com/003/o
                      custom: false
                      developerName: standard-Contact
                      iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/contact_120.png
                      id: 0Qk4H0000009koqSAA
                      itemType: Entity
                      label: Contacts
                      objectApiName: Contact
                      objectLabel: Contact
                      objectLabelPlural: Contacts
                      pageReference:
                        attributes:
                          objectApiName: Contact
                          actionName: home
                        state: {}
                        type: standard__objectPage
                      standardType: null
                    - availableInClassic: true
                      availableInLightning: true
                      color: FF538A
                      content: https://pozil-dev-ed.my.salesforce.com/01Z/o
                      custom: false
                      developerName: standard-Dashboard
                      iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/dashboard_120.png
                      id: 0Qk4H0000009korSAA
                      itemType: Standard
                      label: Dashboards
                      objectApiName: Dashboard
                      objectLabel: Dashboard
                      objectLabelPlural: Dashboards
                      pageReference:
                        attributes:
                          objectApiName: Dashboard
                          actionName: home
                        state: {}
                        type: standard__objectPage
                      standardType: Dashboards
                    - availableInClassic: true
                      availableInLightning: true
                      color: 06A59A
                      content: https://pozil-dev-ed.my.salesforce.com/00O/o
                      custom: false
                      developerName: standard-report
                      iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/report_120.png
                      id: 0Qk4H0000009kosSAA
                      itemType: Standard
                      label: Reports
                      objectApiName: Report
                      objectLabel: Report
                      objectLabelPlural: Reports
                      pageReference:
                        attributes:
                          objectApiName: Report
                          actionName: home
                        state: {}
                        type: standard__objectPage
                      standardType: Reports
                    - availableInClassic: false
                      availableInLightning: true
                      color: 1B96FF
                      content: null
                      custom: false
                      developerName: standard-Feed
                      iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/feed_120.png
                      id: 0Qk4H0000009kotSAA
                      itemType: Standard
                      label: Chatter
                      objectApiName: Feed
                      objectLabel: null
                      objectLabelPlural: null
                      pageReference:
                        attributes:
                          pageName: chatter
                        state: {}
                        type: standard__namedPage
                      standardType: Feed
                    - availableInClassic: true
                      availableInLightning: true
                      color: 1B96FF
                      content: https://pozil-dev-ed.my.salesforce.com/_ui/core/chatter/groups/GroupListPage
                      custom: false
                      developerName: standard-CollaborationGroup
                      iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/groups_120.png
                      id: 0Qk4H0000009kouSAA
                      itemType: Standard
                      label: Groups
                      objectApiName: CollaborationGroup
                      objectLabel: Group
                      objectLabelPlural: Groups
                      pageReference:
                        attributes:
                          objectApiName: CollaborationGroup
                          actionName: home
                        state: {}
                        type: standard__objectPage
                      standardType: Groups
                    - availableInClassic: true
                      availableInLightning: true
                      color: 1B96FF
                      content: https://pozil-dev-ed.my.salesforce.com/_ui/core/chatter/people/PeopleListPage
                      custom: false
                      developerName: standard-OtherUserProfile
                      iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/user_120.png
                      id: 0Qk4H0000009kovSAA
                      itemType: Standard
                      label: People
                      objectApiName: User
                      objectLabel: User
                      objectLabelPlural: People
                      pageReference:
                        attributes:
                          objectApiName: User
                          actionName: home
                        state: {}
                        type: standard__objectPage
                      standardType: People
                    - availableInClassic: true
                      availableInLightning: true
                      color: FF5D2D
                      content: https://pozil-dev-ed.my.salesforce.com/500/o
                      custom: false
                      developerName: standard-Case
                      iconUrl: https://pozil-dev-ed.my.sales

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