Salesforce Describe API

openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Describe 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: Describe
paths:
  /data/v64.0/tooling/sobjects/PlatformEventChannel/describe:
    parameters: []
    get:
      tags:
      - Describe
      summary: Salesforce Describe Event Channel
      operationId: Describeeventchannel
      parameters: []
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Mon, 03 Jul 2023 13:16:20 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=7/15000
            ETag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: '"2aa989f9--gzip"'
            Last-Modified:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Mon, 03 Jul 2023 13:05:05 GMT
            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/Describeeventchannel'
              examples:
                Describeeventchannel200Example:
                  summary: Default Describeeventchannel 200 response
                  x-microcks-default: true
                  value:
                    actionOverrides:
                    - example_value
                    activateable: true
                    associateEntityType: example_value
                    associateParentEntity: example_value
                    childRelationships:
                    - example_value
                    compactLayoutable: true
                    createable: true
                    custom: true
                    customSetting: true
                    deepCloneable: true
                    defaultImplementation: example_value
                    deletable: true
                    deprecatedAndHidden: true
                    extendedBy: example_value
                    extendsInterfaces: example_value
                    feedEnabled: true
                    fields:
                    - aggregatable: true
                      aiPredictionField: true
                      autoNumber: true
                      byteLength: 10
                      calculated: true
                      calculatedFormula: example_value
                      cascadeDelete: true
                      caseSensitive: true
                      compoundFieldName: example_value
                      controllerName: example_value
                      createable: true
                      custom: true
                      defaultValue: example_value
                      defaultValueFormula: example_value
                      defaultedOnCreate: true
                      dependentPicklist: true
                      deprecatedAndHidden: true
                      digits: 10
                      displayLocationInDecimal: true
                      encrypted: true
                      externalId: '500123'
                      extraTypeInfo: example_value
                      filterable: true
                      filteredLookupInfo: example_value
                      formulaTreatNullNumberAsZero: true
                      groupable: true
                      highScaleNumber: true
                      htmlFormatted: true
                      idLookup: true
                      inlineHelpText: example_value
                      label: Example Title
                      length: 10
                      mask: example_value
                      maskType: example_value
                      name: Example Title
                      nameField: true
                      namePointing: true
                      nillable: true
                      permissionable: true
                      picklistValues: {}
                      polymorphicForeignKey: true
                      precision: 10
                      queryByDistance: true
                      referenceTargetField: example_value
                      referenceTo: {}
                      relationshipName: example_value
                      relationshipOrder: example_value
                      restrictedDelete: true
                      restrictedPicklist: true
                      scale: 10
                      searchPrefilterable: true
                      soapType: example_value
                      sortable: true
                      type: example_value
                      unique: true
                      updateable: true
                      writeRequiresMasterRead: true
                    hasSubtypes: true
                    implementedBy: example_value
                    implementsInterfaces: example_value
                    isInterface: true
                    isSubtype: true
                    keyPrefix: example_value
                    label: Example Title
                    labelPlural: example_value
                    layoutable: true
                    listviewable: example_value
                    lookupLayoutable: example_value
                    mergeable: true
                    mruEnabled: true
                    name: Example Title
                    namedLayoutInfos:
                    - example_value
                    networkScopeFieldName: example_value
                    queryable: true
                    recordTypeInfos:
                    - example_value
                    replicateable: true
                    retrieveable: true
                    searchLayoutable: true
                    searchable: true
                    sobjectDescribeOption: example_value
                    supportedScopes:
                    - label: Example Title
                      name: Example Title
                    triggerable: true
                    undeletable: true
                    updateable: true
                    urls:
                      rowTemplate: example_value
                      describe: example_value
                      sobject: 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/tooling/sobjects/EventRelayConfig/describe:
    parameters: []
    get:
      tags:
      - Describe
      summary: Salesforce Describe Event Relay
      operationId: Describeeventrelay
      parameters: []
      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/EventRelayFeedback/describe:
    parameters: []
    get:
      tags:
      - Describe
      summary: Salesforce Describe Event Felay Feedback
      operationId: Describeeventfelayfeedback
      parameters: []
      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/tooling/sobjects/ManagedEventSubscription/describe:
    parameters: []
    get:
      tags:
      - Describe
      summary: Salesforce Describe Managed Event Subscription
      operationId: Describemanagedeventsubscription
      parameters: []
      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:
    parameters: []
    get:
      tags:
      - Describe
      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/{SOBJECT_API_NAME}/describe:
    parameters: []
    get:
      tags:
      - Describe
      summary: Salesforce Sobject Describe
      description: Describes the individual metadata for the specified object. Can also be used to create a new record for a given object. For example, this can be used to retrieve the metadata for the Account object using the GET method, or create a new Account object using the POST method.
      operationId: SObjectDescribe
      parameters:
      - name: SOBJECT_API_NAME
        in: path
        description: Object API name
        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: Fri, 06 Oct 2023 09:03:07 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=54/15000
            ETag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: '"dd40d18c--gzip"'
            Last-Modified:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Wed, 04 Oct 2023 18:33:03 GMT
            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/SObjectDescribe'
              examples:
                Sobjectdescribe200Example:
                  summary: Default SObjectDescribe 200 response
                  x-microcks-default: true
                  value:
                    actionOverrides:
                    - formFactor: example_value
                      isAvailableInTouch: true
                      name: Example Title
                      pageId: '500123'
                      url: https://www.example.com
                    activateable: true
                    associateEntityType: example_value
                    associateParentEntity: example_value
                    childRelationships:
                    - cascadeDelete: true
                      childSObject: example_value
                      deprecatedAndHidden: true
                      field: example_value
                      junctionIdListNames: {}
                      junctionReferenceTo: {}
                      relationshipName: example_value
                      restrictedDelete: true
                    compactLayoutable: true
                    createable: true
                    custom: true
                    customSetting: true
                    deepCloneable: true
                    defaultImplementation: example_value
                    deletable: true
                    deprecatedAndHidden: true
                    extendedBy: example_value
                    extendsInterfaces: example_value
                    feedEnabled: true
                    fields:
                    - aggregatable: true
                      aiPredictionField: true
                      autoNumber: true
                      byteLength: 10
                      calculated: true
                      calculatedFormula: example_value
                      cascadeDelete: true
                      caseSensitive: true
                      compoundFieldName: example_value
                      controllerName: example_value
                      createable: true
                      custom: true
                      defaultValue: example_value
                      defaultValueFormula: example_value
                      defaultedOnCreate: true
                      dependentPicklist: true
                      deprecatedAndHidden: true
                      digits: 10
                      displayLocationInDecimal: true
                      encrypted: true
                      externalId: '500123'
                      extraTypeInfo: example_value
                      filterable: true
                      filteredLookupInfo: example_value
                      formulaTreatNullNumberAsZero: true
                      groupable: true
                      highScaleNumber: true
                      htmlFormatted: true
                      idLookup: true
                      inlineHelpText: example_value
                      label: Example Title
                      length: 10
                      mask: example_value
                      maskType: example_value
                      name: Example Title
                      nameField: true
                      namePointing: true
                      nillable: true
                      permissionable: true
                      picklistValues: {}
                      polymorphicForeignKey: true
                      precision: 10
                      queryByDistance: true
                      referenceTargetField: example_value
                      referenceTo: {}
                      relationshipName: example_value
                      relationshipOrder: example_value
                      restrictedDelete: true
                      restrictedPicklist: true
                      scale: 10
                      searchPrefilterable: true
                      soapType: example_value
                      sortable: true
                      type: example_value
                      unique: true
                      updateable: true
                      writeRequiresMasterRead: true
                    hasSubtypes: true
                    implementedBy: example_value
                    implementsInterfaces: example_value
                    isInterface: true
                    isSubtype: true
                    keyPrefix: example_value
                    label: Example Title
                    labelPlural: example_value
                    layoutable: true
                    listviewable: example_value
                    lookupLayoutable: example_value
                    mergeable: true
                    mruEnabled: true
                    name: Example Title
                    namedLayoutInfos:
                    - example_value
                    networkScopeFieldName: example_value
                    queryable: true
                    recordTypeInfos:
                    - active: true
                      available: true
                      defaultRecordTypeMapping: true
                      developerName: example_value
                      master: true
                      name: Example Title
                      recordTypeId: '500123'
                    replicateable: true
                    retrieveable: true
                    searchLayoutable: true
                    searchable: true
                    sobjectDescribeOption: example_value
                    supportedScopes:
                    - label: Example Title
                      name: Example Title
                    triggerable: true
                    undeletable: true
                    updateable: true
                    urls:
                      compactLayouts: example_value
                      rowTemplate: example_value
                      approvalLayouts: example_value
                      uiDetailTemplate: example_value
                      uiEditTemplate: example_value
                      listviews: example_value
                      describe: example_value
                      uiNewRecord: example_value
                      quickActions: example_value
                      layouts: example_value
                      sobject: 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/sobjects/Global/describe/layouts:
    parameters: []
    get:
      tags:
      - Describe
      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
      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}/describe/layouts:
    parameters: []
    get:
      tags:
      - Describe
      summary: Salesforce Describe Sobject Layouts
      description: Returns a list of layouts and descriptions. The list of fields and the layout name are returned.
      operationId: DescribeSObjectLayouts
      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/sobjects/{SOBJECT_API_NAME}/describe/layouts/{RECORD_TYPE_ID}:
    parameters: []
    get:
      tags:
      - Describe
      summary: Salesforce Describe Sobject Layouts Per Record Type
      description: Returns a list of layouts and descriptions. The list of fields and the layout name are returned.
      operationId: DescribeSObjectLayoutsPerRecordType
      parameters:
      - name: SOBJECT_API_NAME
        in: path
        description: ''
        required: true
        schema:
          type: string
        example: example_value
      - name: RECORD_TYPE_ID
        in: path
        description: ''
        required: true
        schema:
          type: string
        example: '500123'
      - 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/{SOBJECT_API_NAME}/listviews/{QUERY_LOCATOR}/describe:
    parameters: []
    get:
      tags:
      - Describe
      summary: Salesforce List View Describe
      description: Returns detailed information about a list view, including the ID, the columns, and the SOQL query.
      operationId: ListViewDescribe
      parameters:
      - name: SOBJECT_API_NAME
        in: path
        description: ''
        required: true
        schema:
          type: string
        example: example_value
      - name: QUERY_LOCATOR
        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/support/embeddedservice/configuration/{EMBEDDED_SERVICE_CONFIG_DEVELOPERNAME}:
    parameters: []
    get:
      tags:
      - Describe
      summary: Salesforce Embedded Service Configuration Describe
      description: 'Retrieves the values for your Embedded Service deployment configuration, including the branding colors, font, and site URL.


        You must be logged in to the account that owns the EmbeddedServiceConfigDeveloperName you are querying.'
      operationId: EmbeddedServiceConfigurationDescribe
      parameters:
      - name: EMBEDDED_SERVICE_CONFIG_DEVELOPERNAME
        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/tooling/sobjects:
    parameters: []
    get:
      tags:
      - Describe
      summary: Salesforce Get Tooling Describe
      description: Lists the available Tooling API objects and their metadata.
      operationId: GetToolingDescribe
      parameters: []
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Mon, 11 Dec 2023 10:35:19 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=298/15000
            ETag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: '"b0436952--gzip"'
            Last-Modified:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Mon, 11 Dec 2023 09:28:13 GMT
            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/GetToolingDescribe'
                - examples:
                  - encoding: UTF-8
                    maxBatchSize: 200
                    sobjects:
                    - activateable: false
                      associateEntityType: null
                      associateParentEntity: null
                      createable: true
                      custom: false
                      customSetting: false
                      deepCloneable: false
                      deletable: true
                      deprecatedAndHidden: false
                      feedEnabled: false
                      hasSubtypes: false
                      isInterface: false
                      isSubtype: false
                      keyPrefix: 0Pp
                      label: AI Application
                      labelPlural: AI Applications
                      layoutable: false
                      mergeable: false
                      mruEnabled: false
                      name: AIApplication
                      queryable: true
                      replicateable: false
                      retrieveable: true
                      searchable: false
                      trig

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