Salesforce Global API

The Global API from Salesforce — 3 operation(s) for global.

Documentation

Specifications

Schemas & Data

OpenAPI Specification

salesforce-global-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Global 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: Global
paths:
  /data/v64.0/ui-api/actions/global:
    parameters: []
    get:
      tags:
      - Global
      summary: Salesforce Get Global Actions
      description: Get the actions on record detail pages.
      operationId: GetGlobalActions
      parameters: []
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Fri, 06 Oct 2023 10:14:55 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: '"96082978ff1803b51fcee9ce34121cfa--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/GetGlobalActions'
                - examples:
                  - actions:
                      Global:
                        actions:
                        - actionListContext: Global
                          actionTarget: null
                          actionTargetType: null
                          apiName: FeedItem.TextPost
                          externalId: 00D58000000arpq:Global::Global:Desktop:FeedItem.TextPost
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/share_post_120.png
                          id: 0JV4H0000279052WAA
                          isMassAction: 'false'
                          label: Post
                          lwcComponent: null
                          primaryColor: 1B96FF
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: CollaborateComposer
                          sourceObject: Global
                          subtype: Post
                          targetObject: null
                          targetUrl: null
                          type: QuickAction
                        - actionListContext: Global
                          actionTarget: null
                          actionTargetType: null
                          apiName: FeedItem.ContentPost
                          externalId: 00D58000000arpq:Global::Global:Desktop:FeedItem.ContentPost
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/share_file_120.png
                          id: 0JV4H0000279053WAA
                          isMassAction: 'false'
                          label: File
                          lwcComponent: null
                          primaryColor: '939393'
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: null
                          sourceObject: Global
                          subtype: Post
                          targetObject: null
                          targetUrl: null
                          type: QuickAction
                        - actionListContext: Global
                          actionTarget: /services/data/v58.0/quickActions/NewEvent/describe
                          actionTargetType: Describe
                          apiName: Global.NewEvent
                          externalId: 00D58000000arpq:Global::Global:Desktop:09D58000002PE2j
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_event_120.png
                          id: 0JV4H0000279054WAA
                          isMassAction: 'false'
                          label: New Event
                          lwcComponent: null
                          primaryColor: FF538A
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: ActivityComposer
                          sourceObject: Global
                          subtype: Create
                          targetObject: Event
                          targetUrl: null
                          type: QuickAction
                        - actionListContext: Global
                          actionTarget: /services/data/v58.0/quickActions/NewTask/describe
                          actionTargetType: Describe
                          apiName: Global.NewTask
                          externalId: 00D58000000arpq:Global::Global:Desktop:09D58000002PE2f
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_task_120.png
                          id: 0JV4H0000279055WAA
                          isMassAction: 'false'
                          label: New Task
                          lwcComponent: null
                          primaryColor: 3BA755
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: ActivityComposer
                          sourceObject: Global
                          subtype: Create
                          targetObject: Task
                          targetUrl: null
                          type: QuickAction
                        - actionListContext: Global
                          actionTarget: /services/data/v58.0/quickActions/NewContact/describe
                          actionTargetType: Describe
                          apiName: Global.NewContact
                          externalId: 00D58000000arpq:Global::Global:Desktop:09D58000002PE2k
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_contact_120.png
                          id: 0JV4H0000279056WAA
                          isMassAction: 'false'
                          label: New Contact
                          lwcComponent: null
                          primaryColor: 5867E8
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: Page
                          sourceObject: Global
                          subtype: Create
                          targetObject: Contact
                          targetUrl: null
                          type: QuickAction
                        - actionListContext: Global
                          actionTarget: /services/data/v58.0/quickActions/LogACall/describe
                          actionTargetType: Describe
                          apiName: Global.LogACall
                          externalId: 00D58000000arpq:Global::Global:Desktop:09D58000002PE2g
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/log_a_call_120.png
                          id: 0JV4H0000279057WAA
                          isMassAction: 'false'
                          label: Log a Call
                          lwcComponent: null
                          primaryColor: 06A59A
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: ActivityComposer
                          sourceObject: Global
                          subtype: LogACall
                          targetObject: Task
                          targetUrl: null
                          type: QuickAction
                        - actionListContext: Global
                          actionTarget: /services/data/v58.0/quickActions/NewOpportunity/describe
                          actionTargetType: Describe
                          apiName: Global.NewOpportunity
                          externalId: 00D58000000arpq:Global::Global:Desktop:09D58000002PE2l
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_opportunity_120.png
                          id: 0JV4H0000279058WAA
                          isMassAction: 'false'
                          label: New Opportunity
                          lwcComponent: null
                          primaryColor: FF5D2D
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: Page
                          sourceObject: Global
                          subtype: Create
                          targetObject: Opportunity
                          targetUrl: null
                          type: QuickAction
                        - actionListContext: Global
                          actionTarget: /services/data/v58.0/quickActions/NewCase/describe
                          actionTargetType: Describe
                          apiName: Global.NewCase
                          externalId: 00D58000000arpq:Global::Global:Desktop:09D58000002PE2h
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_case_120.png
                          id: 0JV4H0000279059WAA
                          isMassAction: 'false'
                          label: New Case
                          lwcComponent: null
                          primaryColor: FF5D2D
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: Page
                          sourceObject: Global
                          subtype: Create
                          targetObject: Case
                          targetUrl: null
                          type: QuickAction
                        - actionListContext: Global
                          actionTarget: /services/data/v58.0/quickActions/NewLead/describe
                          actionTargetType: Describe
                          apiName: Global.NewLead
                          externalId: 00D58000000arpq:Global::Global:Desktop:09D58000002PE2m
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_lead_120.png
                          id: 0JV4H0000279060WAA
                          isMassAction: 'false'
                          label: New Lead
                          lwcComponent: null
                          primaryColor: FF5D2D
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: Page
                          sourceObject: Global
                          subtype: Create
                          targetObject: Lead
                          targetUrl: null
                          type: QuickAction
                        - actionListContext: Global
                          actionTarget: null
                          actionTargetType: null
                          apiName: FeedItem.LinkPost
                          externalId: 00D58000000arpq:Global::Global:Desktop:FeedItem.LinkPost
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/share_link_120.png
                          id: 0JV4H0000279061WAA
                          isMassAction: 'false'
                          label: Link
                          lwcComponent: null
                          primaryColor: 1B96FF
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: null
                          sourceObject: Global
                          subtype: Post
                          targetObject: null
                          targetUrl: null
                          type: QuickAction
                        - actionListContext: Global
                          actionTarget: null
                          actionTargetType: null
                          apiName: FeedItem.PollPost
                          externalId: 00D58000000arpq:Global::Global:Desktop:FeedItem.PollPost
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/share_poll_120.png
                          id: 0JV4H0000279062WAA
                          isMassAction: 'false'
                          label: Poll
                          lwcComponent: null
                          primaryColor: 1B96FF
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: CollaborateComposer
                          sourceObject: Global
                          subtype: Post
                          targetObject: null
                          targetUrl: null
                          type: QuickAction
                        - actionListContext: Global
                          actionTarget: null
                          actionTargetType: null
                          apiName: FeedItem.QuestionPost
                          externalId: 00D58000000arpq:Global::Global:Desktop:FeedItem.QuestionPost
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/question_post_action_120.png
                          id: 0JV4H0000279063WAA
                          isMassAction: 'false'
                          label: Question
                          lwcComponent: null
                          primaryColor: 3BA755
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: CollaborateComposer
                          sourceObject: Global
                          subtype: Post
                          targetObject: null
                          targetUrl: null
                          type: QuickAction
                        - actionListContext: Global
                          actionTarget: /services/data/v58.0/quickActions/New_Detailed_Account/describe
                          actionTargetType: Describe
                          apiName: Global.New_Detailed_Account
                          externalId: 00D58000000arpq:Global::Global:Desktop:09D58000002Pbt9
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_account_120.png
                          id: 0JV4H0000279064WAA
                          isMassAction: 'false'
                          label: New Detailed Account
                          lwcComponent: null
                          primaryColor: 5867E8
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: Page
                          sourceObject: Global
                          subtype: Create
                          targetObject: Account
                          targetUrl: null
                          type: QuickAction
                        links: []
                        url: /services/data/v58.0/ui-api/actions/global
                    eTag: 96082978ff1803b51fcee9ce34121cfa
                    url: /services/data/v58.0/ui-api/actions/global
                contentMediaType: application/json;charset=UTF-8
              example:
                actions:
                  Global:
                    actions:
                    - actionListContext: Global
                      actionTarget: null
                      actionTargetType: null
                      apiName: FeedItem.TextPost
                      externalId: 00D58000000arpq:Global::Global:Desktop:FeedItem.TextPost
                      iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/share_post_120.png
                      id: 0JV4H0000279052WAA
                      isMassAction: 'false'
                      label: Post
                      lwcComponent: null
                      primaryColor: 1B96FF
                      relatedListRecordId: null
                      relatedSourceObject: null
                      section: CollaborateComposer
                      sourceObject: Global
                      subtype: Post
                      targetObject: null
                      targetUrl: null
                      type: QuickAction
                    - actionListContext: Global
                      actionTarget: null
                      actionTargetType: null
                      apiName: FeedItem.ContentPost
                      externalId: 00D58000000arpq:Global::Global:Desktop:FeedItem.ContentPost
                      iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/share_file_120.png
                      id: 0JV4H0000279053WAA
                      isMassAction: 'false'
                      label: File
                      lwcComponent: null
                      primaryColor: '939393'
                      relatedListRecordId: null
                      relatedSourceObject: null
                      section: null
                      sourceObject: Global
                      subtype: Post
                      targetObject: null
                      targetUrl: null
                      type: QuickAction
                    - actionListContext: Global
                      actionTarget: /services/data/v58.0/quickActions/NewEvent/describe
                      actionTargetType: Describe
                      apiName: Global.NewEvent
                      externalId: 00D58000000arpq:Global::Global:Desktop:09D58000002PE2j
                      iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_event_120.png
                      id: 0JV4H0000279054WAA
                      isMassAction: 'false'
                      label: New Event
                      lwcComponent: null
                      primaryColor: FF538A
                      relatedListRecordId: null
                      relatedSourceObject: null
                      section: ActivityComposer
                      sourceObject: Global
                      subtype: Create
                      targetObject: Event
                      targetUrl: null
                      type: QuickAction
                    - actionListContext: Global
                      actionTarget: /services/data/v58.0/quickActions/NewTask/describe
                      actionTargetType: Describe
                      apiName: Global.NewTask
                      externalId: 00D58000000arpq:Global::Global:Desktop:09D58000002PE2f
                      iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_task_120.png
                      id: 0JV4H0000279055WAA
                      isMassAction: 'false'
                      label: New Task
                      lwcComponent: null
                      primaryColor: 3BA755
                      relatedListRecordId: null
                      relatedSourceObject: null
                      section: ActivityComposer
                      sourceObject: Global
                      subtype: Create
                      targetObject: Task
                      targetUrl: null
                      type: QuickAction
                    - actionListContext: Global
                      actionTarget: /services/data/v58.0/quickActions/NewContact/describe
                      actionTargetType: Describe
                      apiName: Global.NewContact
                      externalId: 00D58000000arpq:Global::Global:Desktop:09D58000002PE2k
                      iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_contact_120.png
                      id: 0JV4H0000279056WAA
                      isMassAction: 'false'
                      label: New Contact
                      lwcComponent: null
                      primaryColor: 5867E8
                      relatedListRecordId: null
                      relatedSourceObject: null
                      section: Page
                      sourceObject: Global
                      subtype: Create
                      targetObject: Contact
                      targetUrl: null
                      type: QuickAction
                    - actionListContext: Global
                      actionTarget: /services/data/v58.0/quickActions/LogACall/describe
                      actionTargetType: Describe
                      apiName: Global.LogACall
                      externalId: 00D58000000arpq:Global::Global:Desktop:09D58000002PE2g
                      iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/log_a_call_120.png
                      id: 0JV4H0000279057WAA
                      isMassAction: 'false'
                      label: Log a Call
                      lwcComponent: null
                      primaryColor: 06A59A
                      relatedListRecordId: null
                      relatedSourceObject: null
                      section: ActivityComposer
                      sourceObject: Global
                      subtype: LogACall
                      targetObject: Task
                      targetUrl: null
                      type: QuickAction
                    - actionListContext: Global
                      actionTarget: /services/data/v58.0/quickActions/NewOpportunity/describe
                      actionTargetType: Describe
                      apiName: Global.NewOpportunity
                      externalId: 00D58000000arpq:Global::Global:Desktop:09D58000002PE2l
                      iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_opportunity_120.png
                      id: 0JV4H0000279058WAA
                      isMassAction: 'false'
                      label: New Opportunity
                      lwcComponent: null
                      primaryColor: FF5D2D
                      relatedListRecordId: null
                      relatedSourceObject: null
                      section: Page
                      sourceObject: Global
                      subtype: Create
                      targetObject: Opportunity
                      targetUrl: null
                      type: QuickAction
                    - actionListContext: Global
                      actionTarget: /services/data/v58.0/quickActions/NewCase/describe
                      actionTargetType: Describe
                      apiName: Global.NewCase
                      externalId: 00D58000000arpq:Global::Global:Desktop:09D58000002PE2h
                      iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_case_120.png
                      id: 0JV4H0000279059WAA
                      isMassAction: 'false'
                      label: New Case
                      lwcComponent: null
                      primaryColor: FF5D2D
                      relatedListRecordId: null
                      relatedSourceObject: null
                      section: Page
                      sourceObject: Global
                      subtype: Create
                      targetObject: Case
                      targetUrl: null
                      type: QuickAction
                    - actionListContext: Global
                      actionTarget: /services/data/v58.0/quickActions/NewLead/describe
                      actionTargetType: Describe
                      apiName: Global.NewLead
                      externalId: 00D58000000arpq:Global::Global:Desktop:09D58000002PE2m
                      iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_lead_120.png
                      id: 0JV4H0000279060WAA
                      isMassAction: 'false'
                      label: New Lead
                      lwcComponent: null
                      primaryColor: FF5D2D
                      relatedListRecordId: null
                      relatedSourceObject: null
                      section: Page
                      sourceObject: Global
                      subtype: Create
                      targetObject: Lead
                      targetUrl: null
                      type: QuickAction
                    - actionListContext: Global
                      actionTarget: null
                      actionTargetType: null
                      apiName: FeedItem.LinkPost
                      externalId: 00D58000000arpq:Global::Global:Desktop:FeedItem.LinkPost
                      iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/share_link_120.png
                      id: 0JV4H0000279061WAA
                      isMassAction: 'false'
                      label: Link
                      lwcComponent: null
                      primaryColor: 1B96FF
                      relatedListRecordId: null
                      relatedSourceObject: null
                      section: null
                      sourceObject: Global
                      subtype: Post
                      targetObject: null
                      targetUrl: null
                      type: QuickAction
                    - actionListContext: Global
                      actionTarget: null
                      actionTargetType: null
                      apiName: FeedItem.PollPost
                      externalId: 00D58000000arpq:Global::Global:Desktop:FeedItem.PollPost
                      iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/share_poll_120.png
                      id: 0JV4H0000279062WAA
                      isMassAction: 'false'
                      label: Poll
                      lwcComponent: null
                      primaryColor: 1B96FF
                      relatedListRecordId: null
                      relatedSourceObject: null
                      section: CollaborateComposer
                      sourceObject: Global
                      subtype: Post
                      targetObject: null
                      targetUrl: null
                      type: QuickAction
                    - actionListContext: Global
                      actionTarget: null
                      actionTargetType: null
                      apiName: FeedItem.QuestionPost
                      externalId: 00D58000000arpq:Global::Global:Desktop:FeedItem.QuestionPost
                      iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/question_post_action_120.png
                      id: 0JV4H0000279063WAA
                      isMassAction: 'false'
                      label: Question
                      lwcComponent: null
                      primaryColor: 3BA755
                      relatedListRecordId: null
                      relatedSourceObject: null
                      section: CollaborateComposer
                      sourceObject: Global
                      subtype: Post
                      targetObject: null
                      targetUrl: null
                      type: QuickAction
                    - actionListContext: Global
                      actionTarget: /services/data/v58.0/quickActions/New_Detailed_Account/describe
                      actionTargetType: Describe
                      apiName: Global.New_Detailed_Account
                      externalId: 00D58000000arpq:Global::Global:Desktop:09D58000002Pbt9
                      iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_account_120.png
                      id: 0JV4H0000279064WAA
                      isMassAction: 'false'
                      label: New Detailed Account
                      lwcComponent: null
                      primaryColor: 5867E8
                      relatedListRecordId: null
                      relatedSourceObject: null
                      section: Page
                      sourceObject: Global
                      subtype: Create
                      targetObject: Account
                      targetUrl: null
                      type: QuickAction
                    links: []
                    url: /services/data/v58.0/ui-api/actions/global
                eTag: 96082978ff1803b51fcee9ce34121cfa
                url: /services/data/v58.0/ui-api/actions/global
      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:
    parameters: []
    get:
      tags:
      - Global
      summary: Salesforce Describe Global
      description: 'Lists the available objects and their metadata for your organization’s data. In addition, it provides the organization encoding, as well as the maximum batch size permitted in queries.


        You can use the If-Modified-Since header with this resource, with the date format EEE, dd MMM yyyy HH:mm:ss z. When using this header, if no available object’s metadata has changed since the provided date, a 304 Not Modified status code is returned with no response body.'
      operationId: DescribeGlobal
      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/sobjects/Global/describe/layouts:
    parameters: []
    get:
      tags:
      - Global
      summary: Salesforce Describe Global Layouts
      description: Returns a list of layouts and descriptions. The list of fields and the layout name are returned.
      operationId: DescribeGlobalLayouts
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        schema:
          const: application/json
          type: string
          examples:
          - application/json
        example: example_value
      resp

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