Salesforce Object Info API

openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Object Info 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: Object Info
  description: Retrieve object metadata including fields, layouts, and picklists
paths:
  /object-info/{objectApiName}:
    get:
      operationId: getObjectInfo
      summary: Salesforce Get Object Metadata
      description: Returns metadata about a Salesforce object including its fields, their types, labels, whether they are required or read-only, their reference targets, and the object's CRUD permissions. Used by Lightning components to build dynamic forms.
      tags:
      - Object Info
      parameters:
      - $ref: '#/components/parameters/ObjectApiName'
      responses:
        '200':
          description: Object metadata retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectInfoRepresentation'
              examples:
                Getobjectinfo200Example:
                  summary: Default getObjectInfo 200 response
                  x-microcks-default: true
                  value:
                    apiName: example_value
                    label: Example Title
                    labelPlural: example_value
                    keyPrefix: example_value
                    createable: true
                    updateable: true
                    deleteable: true
                    queryable: true
                    fields: example_value
                    recordTypeInfos: example_value
                    themeInfo:
                      color: example_value
                      iconUrl: https://www.example.com
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    ObjectInfoRepresentation:
      type: object
      description: Metadata about a Salesforce object
      properties:
        apiName:
          type: string
          example: example_value
        label:
          type: string
          example: Example Title
        labelPlural:
          type: string
          example: example_value
        keyPrefix:
          type: string
          example: example_value
        createable:
          type: boolean
          example: true
        updateable:
          type: boolean
          example: true
        deleteable:
          type: boolean
          example: true
        queryable:
          type: boolean
          example: true
        fields:
          type: object
          description: Field metadata indexed by field API name
          additionalProperties:
            $ref: '#/components/schemas/FieldRepresentation'
          example: example_value
        recordTypeInfos:
          type: object
          additionalProperties: true
          example: example_value
        themeInfo:
          type: object
          properties:
            color:
              type: string
            iconUrl:
              type: string
          example: example_value
    ErrorResponse:
      type: object
      description: API error response
      properties:
        errorCode:
          type: string
          description: Machine-readable error code
          example: example_value
        message:
          type: string
          description: Human-readable error message
          example: example_value
    FieldRepresentation:
      type: object
      description: Metadata for a single field
      properties:
        apiName:
          type: string
          example: example_value
        label:
          type: string
          example: Example Title
        dataType:
          type: string
          enum:
          - Address
          - Boolean
          - Currency
          - Date
          - DateTime
          - Double
          - Email
          - Id
          - Integer
          - Long
          - MultiPicklist
          - Percent
          - Phone
          - Picklist
          - Reference
          - String
          - TextArea
          - Time
          - Url
          example: Address
        required:
          type: boolean
          example: true
        updateable:
          type: boolean
          example: true
        createable:
          type: boolean
          example: true
        nillable:
          type: boolean
          example: true
        referenceToInfos:
          type: array
          items:
            type: object
            properties:
              apiName:
                type: string
              nameFields:
                type: array
                items:
                  type: string
          example: []
  responses:
    NotFound:
      description: Not found. The requested resource does not exist.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  parameters:
    ObjectApiName:
      name: objectApiName
      in: path
      required: true
      description: The API name of the Salesforce object (e.g., Account, Contact, MyObject__c)
      schema:
        type: string
  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}".

        '