Salesforce

Salesforce Views API

The Views API from Salesforce — 2 operation(s) for views.

GitHub OpenAPI

Documentation

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

Specifications

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

Schemas & Data

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

OpenAPI Specification

salesforce-views-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Views 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: Views
paths:
  /data/v64.0/sobjects/{SOBJECT_API_NAME}/listviews:
    parameters: []
    get:
      tags:
      - Views
      summary: Salesforce List Views
      description: Returns the list of list views for the specified sObject, including the ID and other basic information about each list view. You can also get basic information for a specific list view by ID.
      operationId: ListViews
      parameters:
      - 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/ui-api/list-info/{SOBJECT_API_NAME}:
    parameters: []
    get:
      tags:
      - Views
      summary: Salesforce Get List Views for an Object
      description: Get list views associated with an object.
      operationId: GetListViewsforanObject
      parameters:
      - name: SOBJECT_API_NAME
        in: path
        description: API name of a UI API supported object.
        required: true
        schema:
          type: string
          examples:
          - Account
        example: example_value
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Fri, 06 Oct 2023 09:49: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-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: '"7a9cf6dc597cbc985bab8a26df2f1752--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/GetListViewsforanObject'
                - examples:
                  - count: 6
                    currentPageToken: '0'
                    currentPageUrl: /services/data/v62.0/ui-api/list-info/Account?pageSize=20&pageToken=0
                    lists:
                    - apiName: AllAccounts
                      id: 00B58000002ssinEAA
                      label: All Accounts
                      url: /services/data/v62.0/ui-api/list-info/Account/AllAccounts
                    - apiName: MyAccounts
                      id: 00B58000002ssivEAA
                      label: My Accounts
                      url: /services/data/v62.0/ui-api/list-info/Account/MyAccounts
                    - apiName: NewLastWeek
                      id: 00B58000002ssiHEAQ
                      label: New Last Week
                      url: /services/data/v62.0/ui-api/list-info/Account/NewLastWeek
                    - apiName: NewThisWeek
                      id: 00B58000002ssi6EAA
                      label: New This Week
                      url: /services/data/v62.0/ui-api/list-info/Account/NewThisWeek
                    - apiName: PlatinumandGoldSLACustomers
                      id: 00B58000002ssiXEAQ
                      label: Platinum and Gold SLA Customers
                      url: /services/data/v62.0/ui-api/list-info/Account/PlatinumandGoldSLACustomers
                    - apiName: RecentlyViewedAccounts
                      id: 00B58000002ssimEAA
                      label: Recently Viewed Accounts
                      url: /services/data/v62.0/ui-api/list-info/Account/RecentlyViewedAccounts
                    nextPageToken: null
                    nextPageUrl: null
                    objectApiName: Account
                    pageSize: 20
                    previousPageToken: null
                    previousPageUrl: null
                    queryString: null
                    recentListsOnly: false
                contentMediaType: application/json;charset=UTF-8
              example:
                count: 6
                currentPageToken: '0'
                currentPageUrl: /services/data/v62.0/ui-api/list-info/Account?pageSize=20&pageToken=0
                lists:
                - apiName: AllAccounts
                  id: 00B58000002ssinEAA
                  label: All Accounts
                  url: /services/data/v62.0/ui-api/list-info/Account/AllAccounts
                - apiName: MyAccounts
                  id: 00B58000002ssivEAA
                  label: My Accounts
                  url: /services/data/v62.0/ui-api/list-info/Account/MyAccounts
                - apiName: NewLastWeek
                  id: 00B58000002ssiHEAQ
                  label: New Last Week
                  url: /services/data/v62.0/ui-api/list-info/Account/NewLastWeek
                - apiName: NewThisWeek
                  id: 00B58000002ssi6EAA
                  label: New This Week
                  url: /services/data/v62.0/ui-api/list-info/Account/NewThisWeek
                - apiName: PlatinumandGoldSLACustomers
                  id: 00B58000002ssiXEAQ
                  label: Platinum and Gold SLA Customers
                  url: /services/data/v62.0/ui-api/list-info/Account/PlatinumandGoldSLACustomers
                - apiName: RecentlyViewedAccounts
                  id: 00B58000002ssimEAA
                  label: Recently Viewed Accounts
                  url: /services/data/v62.0/ui-api/list-info/Account/RecentlyViewedAccounts
                nextPageToken: null
                nextPageUrl: null
                objectApiName: Account
                pageSize: 20
                previousPageToken: null
                previousPageUrl: null
                queryString: null
                recentListsOnly: false
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    GetListViewsforanObject:
      title: GetListViewsforanObject
      required:
      - count
      - currentPageToken
      - currentPageUrl
      - lists
      - nextPageToken
      - nextPageUrl
      - objectApiName
      - pageSize
      - previousPageToken
      - previousPageUrl
      - queryString
      - recentListsOnly
      type: object
      properties:
        count:
          type: integer
          contentEncoding: int32
          example: 42
        currentPageToken:
          type: string
          example: CAUQAA
        currentPageUrl:
          type: string
          example: https://www.example.com
        lists:
          type: array
          items:
            $ref: '#/components/schemas/List'
          description: ''
          example: []
        nextPageToken:
          type:
          - string
          - 'null'
          example: CAUQAA
        nextPageUrl:
          type:
          - string
          - 'null'
          example: https://www.example.com
        objectApiName:
          type: string
          example: example_value
        pageSize:
          type: integer
          contentEncoding: int32
          example: 10
        previousPageToken:
          type:
          - string
          - 'null'
          example: CAUQAA
        previousPageUrl:
          type:
          - string
          - 'null'
          example: https://www.example.com
        queryString:
          type:
          - string
          - 'null'
          example: example_value
        recentListsOnly:
          type: boolean
          example: true
      examples:
      - count: 6
        currentPageToken: '0'
        currentPageUrl: /services/data/v62.0/ui-api/list-info/Account?pageSize=20&pageToken=0
        lists:
        - apiName: AllAccounts
          id: 00B58000002ssinEAA
          label: All Accounts
          url: /services/data/v62.0/ui-api/list-info/Account/AllAccounts
        - apiName: MyAccounts
          id: 00B58000002ssivEAA
          label: My Accounts
          url: /services/data/v62.0/ui-api/list-info/Account/MyAccounts
        - apiName: NewLastWeek
          id: 00B58000002ssiHEAQ
          label: New Last Week
          url: /services/data/v62.0/ui-api/list-info/Account/NewLastWeek
        - apiName: NewThisWeek
          id: 00B58000002ssi6EAA
          label: New This Week
          url: /services/data/v62.0/ui-api/list-info/Account/NewThisWeek
        - apiName: PlatinumandGoldSLACustomers
          id: 00B58000002ssiXEAQ
          label: Platinum and Gold SLA Customers
          url: /services/data/v62.0/ui-api/list-info/Account/PlatinumandGoldSLACustomers
        - apiName: RecentlyViewedAccounts
          id: 00B58000002ssimEAA
          label: Recently Viewed Accounts
          url: /services/data/v62.0/ui-api/list-info/Account/RecentlyViewedAccounts
        nextPageToken: null
        nextPageUrl: null
        objectApiName: Account
        pageSize: 20
        previousPageToken: null
        previousPageUrl: null
        queryString: null
        recentListsOnly: false
    List:
      title: List
      required:
      - apiName
      - id
      - label
      - url
      type: object
      properties:
        apiName:
          type: string
          example: example_value
        id:
          type: string
          example: abc123
        label:
          type: string
          example: Example Title
        url:
          type: string
          example: https://www.example.com
      examples:
      - apiName: AllAccounts
        id: 00B58000002ssinEAA
        label: All Accounts
        url: /services/data/v62.0/ui-api/list-info/Account/AllAccounts
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: 'OAuth 2.0 Bearer token obtained from the Salesforce OAuth 2.0 token endpoint. Include this token in the Authorization header as "Bearer {access_token}".

        '