Salesforce Picklists API

openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Picklists 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: Picklists
  description: Dependent and independent picklist value endpoints
paths:
  /object-info/{objectApiName}/picklist-values/{recordTypeId}:
    get:
      operationId: getPicklistValues
      summary: Salesforce Get Picklist Values for a Record Type
      description: Returns picklist values for all picklist fields on an object for a given record type. Values include labels, valid values, and dependencies between picklist fields.
      tags:
      - Picklists
      parameters:
      - $ref: '#/components/parameters/ObjectApiName'
      - name: recordTypeId
        in: path
        required: true
        description: The record type ID or the string '012000000000000AAA' for the master record type
        schema:
          type: string
        example: '500123'
      responses:
        '200':
          description: Picklist values retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PicklistValuesCollection'
              examples:
                Getpicklistvalues200Example:
                  summary: Default getPicklistValues 200 response
                  x-microcks-default: true
                  value:
                    picklistFieldValues: example_value
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  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
    PicklistValuesCollection:
      type: object
      description: Collection of picklist values for all picklist fields on an object
      properties:
        picklistFieldValues:
          type: object
          additionalProperties:
            type: object
            properties:
              controllerValues:
                type: object
                additionalProperties:
                  type: integer
              defaultValue:
                nullable: true
              url:
                type: string
              values:
                type: array
                items:
                  $ref: '#/components/schemas/PicklistValue'
          example: example_value
    PicklistValue:
      type: object
      description: A single picklist option
      properties:
        attributes:
          nullable: true
          example: example_value
        label:
          type: string
          example: Example Title
        validFor:
          type: array
          items:
            type: integer
          example: []
        value:
          type: string
          example: example_value
  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}".

        '