Salesforce Object Info API

openapi: 3.2.0
info:
  title: Salesforce UI Object Info API
  description: The Salesforce UI API provides a comprehensive REST interface for building user interfaces that work with Salesforce metadata and data. It returns layout information, picklist values, list views, record data, and object metadata that Lightning components rely on. Unlike the general REST API, the UI API returns UI-ready data including display labels, field types, formatting hints, and page layout assignments.
  version: '59.0'
  contact:
    name: Salesforce Developer Support
    url: https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/
  termsOfService: https://www.salesforce.com/company/legal/agreements/
servers:
- url: https://{instanceName}.salesforce.com/services/data/v{version}/ui-api
  description: Salesforce org UI API base
  variables:
    instanceName:
      description: Salesforce org instance name or custom domain
      default: myorg
    version:
      description: Salesforce API version
      default: '59.0'
security:
- oauthBearerToken: []
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:
  responses:
    NotFound:
      description: Not found. The requested resource does not exist.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    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: []
    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
  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:
    oauthBearerToken:
      type: http
      scheme: bearer
      description: Salesforce OAuth 2.0 Bearer Token
externalDocs:
  description: Salesforce UI API Documentation
  url: https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/