Salesforce Names API

openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Names 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: Names
paths:
  /data/v64.0/named-credentials/external-credentials/{DEVELOPER_NAME}:
    parameters: []
    get:
      tags:
      - Names
      summary: Salesforce Get External Credentials by Developer Name
      description: Get an external credential, including the named credentials and principals associated with it and the type and status of each principal.
      operationId: GetExternalCredentialsbyDeveloperName
      parameters:
      - name: DEVELOPER_NAME
        in: path
        description: ''
        required: true
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Mon, 20 Nov 2023 16:49:36 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/SuccessfulGetExternalCredentialsbyDeveloperName'
                - examples:
                  - authenticationProtocol: Custom
                    authenticationProtocolVariant: NoAuthentication
                    authenticationStatus: NotConfigured
                    customHeaders: []
                    developerName: Test
                    id: 0pt...
                    masterLabel: Test
                    parameters: []
                    principals: []
                    relatedNamedCredentials:
                    - developerName: Test
                      id: 0XA...
                      masterLabel: Test
                      url: /services/data/v58.0/named-credentials/named-credential-setup/Test
                    url: /services/data/v58.0/named-credentials/external-credentials/Test
                contentMediaType: application/json;charset=UTF-8
              example:
                authenticationProtocol: Custom
                authenticationProtocolVariant: NoAuthentication
                authenticationStatus: NotConfigured
                customHeaders: []
                developerName: Test
                id: 0pt...
                masterLabel: Test
                parameters: []
                principals: []
                relatedNamedCredentials:
                - developerName: Test
                  id: 0XA...
                  masterLabel: Test
                  url: /services/data/v58.0/named-credentials/named-credential-setup/Test
                url: /services/data/v58.0/named-credentials/external-credentials/Test
      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/named-credentials/named-credential-setup/{DEVELOPER_NAME}:
    parameters: []
    get:
      tags:
      - Names
      summary: Salesforce Get Named Credential by Developer Name
      description: Get a named credential.
      operationId: GetNamedCredentialbyDeveloperName
      parameters:
      - name: DEVELOPER_NAME
        in: path
        description: ''
        required: true
        schema:
          type: string
          examples:
          - 'null'
        example: example_value
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Mon, 20 Nov 2023 16:50:01 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/SuccessfulGetNamedCredentialbyDeveloperName'
                - examples:
                  - calloutOptions:
                      allowMergeFieldsInBody: false
                      allowMergeFieldsInHeader: false
                      generateAuthorizationHeader: true
                    calloutUrl: https://my.example.com
                    customHeaders: []
                    developerName: Test
                    externalCredentials:
                    - developerName: Test
                      id: 0pt...
                      masterLabel: Test
                      url: /services/data/v58.0/named-credentials/external-credentials/Test
                    id: 0XA...
                    masterLabel: Test
                    parameters: []
                    type: SecuredEndpoint
                    url: /services/data/v58.0/named-credentials/named-credential-setup/Test
                contentMediaType: application/json;charset=UTF-8
              example:
                calloutOptions:
                  allowMergeFieldsInBody: false
                  allowMergeFieldsInHeader: false
                  generateAuthorizationHeader: true
                calloutUrl: https://my.example.com
                customHeaders: []
                developerName: Test
                externalCredentials:
                - developerName: Test
                  id: 0pt...
                  masterLabel: Test
                  url: /services/data/v58.0/named-credentials/external-credentials/Test
                id: 0XA...
                masterLabel: Test
                parameters: []
                type: SecuredEndpoint
                url: /services/data/v58.0/named-credentials/named-credential-setup/Test
      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/{EVENT_NAME}/eventSchema:
    parameters: []
    get:
      tags:
      - Names
      summary: Salesforce Platform Event Schema by Event Name
      description: Set, reset, or get information about a user password. This resource is available in REST API version 24.0 and later.
      operationId: PlatformEventSchemabyEventName
      parameters:
      - name: EVENT_NAME
        in: path
        description: API Name of the event
        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: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Mon, 03 Jul 2023 13:06:08 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
            Sforce-Limit-Info:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: api-usage=2/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:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/PlatformEventSchemabyEventName'
              examples:
                Platformeventschemabyeventname200Example:
                  summary: Default PlatformEventSchemabyEventName 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    namespace: example_value
                    type: example_value
                    fields:
                    - name: Example Title
                      type: example_value
      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-records/{SOBJECT_API_NAME}/{LIST_VIEW_API_NAME}:
    parameters: []
    get:
      tags:
      - Names
      summary: Salesforce Get List View Records by Api Name
      description: Get record data for a list view by list view API name using URL parameters.
      operationId: GetListViewRecordsbyAPIName
      parameters:
      - name: SOBJECT_API_NAME
        in: path
        description: API name of a UI API supported object.
        required: true
        schema:
          type: string
        example: example_value
      - name: LIST_VIEW_API_NAME
        in: path
        description: API name of a list view, such as AllAccounts, __Recent, or __SearchResult.
        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 09:54:16 GMT
            Strict-Transport-Security:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: max-age=63072000; includeSubDomains
            X-Content-Type-Options:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: nosniff
            X-Robots-Tag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: none
            Cache-Control:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: no-cache,must-revalidate,max-age=0,no-store,private
            Vary:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Accept-Encoding
            Content-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: gzip
            Transfer-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: chunked
          content:
            application/json;charset=UTF-8:
              schema:
                allOf:
                - $ref: '#/components/schemas/GetListViewRecordsperAPIName'
                - examples:
                  - count: 50
                    currentPageToken: '0'
                    currentPageUrl: /services/data/v62.0/ui-api/list-records/00B58000002ssinEAA?pageSize=50&pageToken=0
                    fields: []
                    listInfoETag: 55ebdd0de6c2f1e17f63bf4581d64f76
                    listReference:
                      id: 00B58000002ssinEAA
                      listViewApiName: AllAccounts
                      objectApiName: Account
                      type: listView
                    nextPageToken: '50'
                    nextPageUrl: /services/data/v62.0/ui-api/list-records/00B58000002ssinEAA?pageSize=50&pageToken=50
                    optionalFields: []
                    pageSize: 50
                    previousPageToken: null
                    previousPageUrl: null
                    records:
                    - apiName: Account
                      childRelationships: {}
                      eTag: c7b296e1aa5fa482e1f77e8dc0e0b5e1
                      fields:
                        BillingCountry:
                          displayValue: null
                          value: USA
                        CreatedDate:
                          displayValue: null
                          value: '2020-02-27T09:28:06.000Z'
                        Id:
                          displayValue: null
                          value: 0014H00002LbR7QQAV
                        LastModifiedById:
                          displayValue: null
                          value: 00558000000yFyDAAU
                        LastModifiedDate:
                          displayValue: null
                          value: '2023-10-04T18:35:13.000Z'
                        Name:
                          displayValue: null
                          value: ABC Computing
                        Owner:
                          displayValue: Philippe Ozil
                          value:
                            apiName: User
                            childRelationships: {}
                            eTag: cd72f37056763253524392799303114f
                            fields:
                              Alias:
                                displayValue: null
                                value: POzil
                              CreatedDate:
                                displayValue: null
                                value: '2016-05-09T13:51:39.000Z'
                              Id:
                                displayValue: null
                                value: 00558000000yFyDAAU
                              LastModifiedById:
                                displayValue: null
                                value: 00558000000yFyDAAU
                              LastModifiedDate:
                                displayValue: null
                                value: '2023-10-06T08:34:22.000Z'
                              Name:
                                displayValue: null
                                value: Philippe Ozil
                              SystemModstamp:
                                displayValue: null
                                value: '2023-10-06T08:34:22.000Z'
                            id: 00558000000yFyDAAU
                            lastModifiedById: 00558000000yFyDAAU
                            lastModifiedDate: '2023-10-06T08:34:22.000Z'
                            recordTypeId: null
                            recordTypeInfo: null
                            systemModstamp: '2023-10-06T08:34:22.000Z'
                        OwnerId:
                          displayValue: null
                          value: 00558000000yFyDAAU
                        Phone:
                          displayValue: null
                          value: '123123123'
                        Site:
                          displayValue: null
                          value: null
                        SystemModstamp:
                          displayValue: null
                          value: '2023-10-04T18:35:13.000Z'
                        Type:
                          displayValue: null
                          value: null
                      id: 0014H00002LbR7QQAV
                      lastModifiedById: 00558000000yFyDAAU
                      lastModifiedDate: '2023-10-04T18:35:13.000Z'
                      recordTypeId: 012000000000000AAA
                      recordTypeInfo: null
                      systemModstamp: '2023-10-04T18:35:13.000Z'
                    - apiName: Account
                      childRelationships: {}
                      eTag: cfeff90a24208129b7cf7be4e47dda99
                      fields:
                        BillingCountry:
                          displayValue: null
                          value: USA
                        CreatedDate:
                          displayValue: null
                          value: '2016-05-09T13:51:39.000Z'
                        Id:
                          displayValue: null
                          value: 00158000006QBOhAAO
                        LastModifiedById:
                          displayValue: null
                          value: 00558000000yFyDAAU
                        LastModifiedDate:
                          displayValue: null
                          value: '2020-09-29T16:04:02.000Z'
                        Name:
                          displayValue: null
                          value: Burlington Textiles Corp of America
                        Owner:
                          displayValue: Philippe Ozil
                          value:
                            apiName: User
                            childRelationships: {}
                            eTag: cd72f37056763253524392799303114f
                            fields:
                              Alias:
                                displayValue: null
                                value: POzil
                              CreatedDate:
                                displayValue: null
                                value: '2016-05-09T13:51:39.000Z'
                              Id:
                                displayValue: null
                                value: 00558000000yFyDAAU
                              LastModifiedById:
                                displayValue: null
                                value: 00558000000yFyDAAU
                              LastModifiedDate:
                                displayValue: null
                                value: '2023-10-06T08:34:22.000Z'
                              Name:
                                displayValue: null
                                value: Philippe Ozil
                              SystemModstamp:
                                displayValue: null
                                value: '2023-10-06T08:34:22.000Z'
                            id: 00558000000yFyDAAU
                            lastModifiedById: 00558000000yFyDAAU
                            lastModifiedDate: '2023-10-06T08:34:22.000Z'
                            recordTypeId: null
                            recordTypeInfo: null
                            systemModstamp: '2023-10-06T08:34:22.000Z'
                        OwnerId:
                          displayValue: null
                          value: 00558000000yFyDAAU
                        Phone:
                          displayValue: null
                          value: (336) 222-7000
                        Site:
                          displayValue: null
                          value: null
                        SystemModstamp:
                          displayValue: null
                          value: '2020-09-29T16:04:02.000Z'
                        Type:
                          displayValue: Customer
                          value: Customer
                      id: 00158000006QBOhAAO
                      lastModifiedById: 00558000000yFyDAAU
                      lastModifiedDate: '2020-09-29T16:04:02.000Z'
                      recordTypeId: 012000000000000AAA
                      recordTypeInfo: null
                      systemModstamp: '2020-09-29T16:04:02.000Z'
                    - apiName: Account
                      childRelationships: {}
                      eTag: c42c5257506520c737965101b225840c
                      fields:
                        BillingCountry:
                          displayValue: null
                          value: USA
                        CreatedDate:
                          displayValue: null
                          value: '2016-05-09T13:51:39.000Z'
                        Id:
                          displayValue: null
                          value: 00158000006QBOjAAO
                        LastModifiedById:
                          displayValue: null
                          value: 00558000000yFyDAAU
                        LastModifiedDate:
                          displayValue: null
                          value: '2020-09-29T15:52:06.000Z'
                        Name:
                          displayValue: null
                          value: Dickenson Co.
                        Owner:
                          displayValue: Philippe Ozil
                          value:
                            apiName: User
                            childRelationships: {}
                            eTag: cd72f37056763253524392799303114f
                            fields:
                              Alias:
                                displayValue: null
                                value: POzil
                              CreatedDate:
                                displayValue: null
                                value: '2016-05-09T13:51:39.000Z'
                              Id:
                                displayValue: null
                                value: 00558000000yFyDAAU
                              LastModifiedById:
                                displayValue: null
                                value: 00558000000yFyDAAU
                              LastModifiedDate:
                                displayValue: null
                                value: '2023-10-06T08:34:22.000Z'
                              Name:
                                displayValue: null
                                value: Philippe Ozil
                              SystemModstamp:
                                displayValue: null
                                value: '2023-10-06T08:34:22.000Z'
                            id: 00558000000yFyDAAU
                            lastModifiedById: 00558000000yFyDAAU
                            lastModifiedDate: '2023-10-06T08:34:22.000Z'
                            recordTypeId: null
                            recordTypeInfo: null
                            systemModstamp: '2023-10-06T08:34:22.000Z'
                        OwnerId:
                          displayValue: null
                          value: 00558000000yFyDAAU
                        Phone:
                          displayValue: null
                          value: (785) 241-6200
                        Site:
                          displayValue: null
                          value: null
                        SystemModstamp:
                          displayValue: null
                          value: '2020-09-29T15:52:06.000Z'
                        Type:
                          displayValue: Customer
                          value: Customer
                      id: 00158000006QBOjAAO
                      lastModifiedById: 00558000000yFyDAAU
                      lastModifiedDate: '2020-09-29T15:52:06.000Z'
                      recordTypeId: 012000000000000AAA
                      recordTypeInfo: null
                      systemModstamp: '2020-09-29T15:52:06.000Z'
                    - apiName: Account
                      childRelationships: {}
                      eTag: 2f21e61d45d05263809593342f5761f4
                      fields:
                        BillingCountry:
                          displayValue: null
                          value: France
                        CreatedDate:
                          displayValue: null
                          value: '2016-05-09T13:51:39.000Z'
                        Id:
                          displayValue: null
                          value: 00158000006QBOiAAO
                        LastModifiedById:
                          displayValue: null
                          value: 00558000000yFyDAAU
                        LastModifiedDate:
                          displayValue: null
                          value: '2016-05-11T08:48:05.000Z'
                        Name:
                          displayValue: null
                          value: Pyramid Construction Inc.
                        Owner:
                          displayValue: Philippe Ozil
                          value:
                            apiName: User
                            childRelationships: {}
                            eTag: cd72f37056763253524392799303114f
                            fields:
                              Alias:
                                displayValue: null
                                value: POzil
                              CreatedDate:
                                displayValue: null
                                value: '2016-05-09T13:51:39.000Z'
                              Id:
                                displayValue: null
                                value: 00558000000yFyDAAU
                              LastModifiedById:
                                displayValue: null
                                value: 00558000000yFyDAAU
                              LastModifiedDate:
                                displayValue: null
                                value: '2023-10-06T08:34:22.000Z'
                              Name:
                                displayValue: null
                                value: Philippe Ozil
                              SystemModstamp:
                                displayValue: null
                                value: '2023-10-06T08:34:22.000Z'
                            id: 00558000000yFyDAAU
                            lastModifiedById: 00558000000yFyDAAU
                            lastModifiedDate: '2023-10-06T08:34:22.000Z'
                            recordTypeId: null
                            recordTypeInfo: null
                            systemModstamp: '2023-10-06T08:34:22.000Z'
                        OwnerId:
                          displayValue: null
                          value: 00558000000yFyDAAU
                        Phone:
                          displayValue: null
                          value: (014) 427-4427
                        Site:
                          displayValue: null
                          value: null
                        SystemModstamp:
                          displayValue: null
                          value: '2016-05-11T08:48:05.000Z'
                        Type:
                          displayValue: Customer
                          value: Customer
     

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