Salesforce Directories API

The Directories API from Salesforce — 1 operation(s) for directories.

Documentation

Specifications

Schemas & Data

OpenAPI Specification

salesforce-directories-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Directories 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: Directories
paths:
  /data/v64.0/ui-api/object-info:
    parameters: []
    get:
      tags:
      - Directories
      summary: Salesforce Get a Directory of Supported Objects
      description: Get a Salesforce org’s active theme. A theme uses colors, images, and banners to change the overall appearance of Salesforce. Administrators can define themes and switch themes to provide a different look. The User Interface API response matches the Admin’s selection.
      operationId: GetaDirectoryofSupportedObjects
      parameters: []
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Wed, 27 Sep 2023 15:54:23 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/GetaDirectoryofSupportedObjects'
                - examples:
                  - objects:
                      Account:
                        apiName: Account
                        keyPrefix: '001'
                        label: Account
                        labelPlural: Accounts
                        nameFields:
                        - Name
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/Account
                      AccountBrand:
                        apiName: AccountBrand
                        keyPrefix: 0TU
                        label: Account Brand
                        labelPlural: Account Brands
                        nameFields:
                        - Name
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/AccountBrand
                      AccountHistory:
                        apiName: AccountHistory
                        keyPrefix: '017'
                        label: Account History
                        labelPlural: Account History
                        nameFields: []
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/AccountHistory
                      AccountPartner:
                        apiName: AccountPartner
                        keyPrefix: 00I
                        label: Account Partner
                        labelPlural: Account Partner
                        nameFields: []
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/AccountPartner
                      ActiveScratchOrg:
                        apiName: ActiveScratchOrg
                        keyPrefix: 2AS
                        label: Active Scratch Org
                        labelPlural: Active Scratch Orgs
                        nameFields:
                        - Name
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/ActiveScratchOrg
                      ActiveScratchOrgHistory:
                        apiName: ActiveScratchOrgHistory
                        keyPrefix: '017'
                        label: Active Scratch Org History
                        labelPlural: Active Scratch Org History
                        nameFields: []
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/ActiveScratchOrgHistory
                      ApiAnomalyEventStore:
                        apiName: ApiAnomalyEventStore
                        keyPrefix: 0j6
                        label: API Anomaly Event Store
                        labelPlural: API Anomaly Event Stores
                        nameFields:
                        - ApiAnomalyEventNumber
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/ApiAnomalyEventStore
                      AppAnalyticsQueryRequest:
                        apiName: AppAnalyticsQueryRequest
                        keyPrefix: 0XI
                        label: App Analytics Query Request
                        labelPlural: App Analytics Query Requests
                        nameFields:
                        - Name
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/AppAnalyticsQueryRequest
                      AppMenuItem:
                        apiName: AppMenuItem
                        keyPrefix: 0DS
                        label: AppMenuItem
                        labelPlural: AppMenuItems
                        nameFields: []
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/AppMenuItem
                      Asset:
                        apiName: Asset
                        keyPrefix: 02i
                        label: Asset
                        labelPlural: Assets
                        nameFields:
                        - Name
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/Asset
                      AssetHistory:
                        apiName: AssetHistory
                        keyPrefix: '017'
                        label: Asset History
                        labelPlural: Asset History
                        nameFields: []
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/AssetHistory
                      AssetRelationship:
                        apiName: AssetRelationship
                        keyPrefix: 1AR
                        label: Asset Relationship
                        labelPlural: Asset Relationships
                        nameFields:
                        - AssetRelationshipNumber
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/AssetRelationship
                      AssetRelationshipHistory:
                        apiName: AssetRelationshipHistory
                        keyPrefix: '017'
                        label: Asset Relationship History
                        labelPlural: Asset Relationship History
                        nameFields: []
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/AssetRelationshipHistory
                      AuthorizationForm:
                        apiName: AuthorizationForm
                        keyPrefix: 0cI
                        label: Authorization Form
                        labelPlural: Authorization Forms
                        nameFields:
                        - Name
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/AuthorizationForm
                      AuthorizationFormConsent:
                        apiName: AuthorizationFormConsent
                        keyPrefix: 0cK
                        label: Authorization Form Consent
                        labelPlural: Authorization Form Consents
                        nameFields:
                        - Name
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/AuthorizationFormConsent
                      AuthorizationFormConsentHistory:
                        apiName: AuthorizationFormConsentHistory
                        keyPrefix: '017'
                        label: Authorization Form Consent History
                        labelPlural: Authorization Form Consent History
                        nameFields: []
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/AuthorizationFormConsentHistory
                      AuthorizationFormDataUse:
                        apiName: AuthorizationFormDataUse
                        keyPrefix: 0cM
                        label: Authorization Form Data Use
                        labelPlural: Authorization Form Data Uses
                        nameFields:
                        - Name
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/AuthorizationFormDataUse
                      AuthorizationFormDataUseHistory:
                        apiName: AuthorizationFormDataUseHistory
                        keyPrefix: '017'
                        label: Authorization Form Data Use History
                        labelPlural: Authorization Form Data Use History
                        nameFields: []
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/AuthorizationFormDataUseHistory
                      AuthorizationFormHistory:
                        apiName: AuthorizationFormHistory
                        keyPrefix: '017'
                        label: Authorization Form History
                        labelPlural: Authorization Form History
                        nameFields: []
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/AuthorizationFormHistory
                      AuthorizationFormText:
                        apiName: AuthorizationFormText
                        keyPrefix: 0cN
                        label: Authorization Form Text
                        labelPlural: Authorization Form Texts
                        nameFields:
                        - Name
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/AuthorizationFormText
                      AuthorizationFormTextHistory:
                        apiName: AuthorizationFormTextHistory
                        keyPrefix: '017'
                        label: Authorization Form Text History
                        labelPlural: Authorization Form Text History
                        nameFields: []
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/AuthorizationFormTextHistory
                      BackgroundOperation:
                        apiName: BackgroundOperation
                        keyPrefix: 08P
                        label: Background Operation
                        labelPlural: Background Operations
                        nameFields:
                        - Name
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/BackgroundOperation
                      BusinessBrand:
                        apiName: BusinessBrand
                        keyPrefix: 1BU
                        label: Business Brand
                        labelPlural: Business Brands
                        nameFields:
                        - Name
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/BusinessBrand
                      BusinessHours:
                        apiName: BusinessHours
                        keyPrefix: 01m
                        label: Business Hours
                        labelPlural: Business Hours
                        nameFields:
                        - Name
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/BusinessHours
                      Campaign:
                        apiName: Campaign
                        keyPrefix: '701'
                        label: Campaign
                        labelPlural: Campaigns
                        nameFields:
                        - Name
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/Campaign
                      CampaignHistory:
                        apiName: CampaignHistory
                        keyPrefix: '017'
                        label: Campaign Field History
                        labelPlural: Campaign Field History
                        nameFields: []
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/CampaignHistory
                      CampaignMember:
                        apiName: CampaignMember
                        keyPrefix: 00v
                        label: Campaign Member
                        labelPlural: Campaign Members
                        nameFields: []
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/CampaignMember
                      CampaignMemberStatus:
                        apiName: CampaignMemberStatus
                        keyPrefix: 01Y
                        label: Campaign Member Status
                        labelPlural: Campaign Member Statuses
                        nameFields: []
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/CampaignMemberStatus
                      Case:
                        apiName: Case
                        keyPrefix: '500'
                        label: Case
                        labelPlural: Cases
                        nameFields:
                        - CaseNumber
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/Case
                      CaseComment:
                        apiName: CaseComment
                        keyPrefix: 00a
                        label: Case Comment
                        labelPlural: Case Comments
                        nameFields: []
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/CaseComment
                      CaseContactRole:
                        apiName: CaseContactRole
                        keyPrefix: 03j
                        label: Case Contact Role
                        labelPlural: Case Contact Role
                        nameFields: []
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/CaseContactRole
                      CaseHistory:
                        apiName: CaseHistory
                        keyPrefix: '017'
                        label: Case History
                        labelPlural: Case History
                        nameFields: []
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/CaseHistory
                      ChannelProgram:
                        apiName: ChannelProgram
                        keyPrefix: 0Pk
                        label: Channel Program
                        labelPlural: Channel Programs
                        nameFields:
                        - Name
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/ChannelProgram
                      ChannelProgramHistory:
                        apiName: ChannelProgramHistory
                        keyPrefix: '017'
                        label: Channel Program History
                        labelPlural: Channel Program History
                        nameFields: []
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/ChannelProgramHistory
                      ChannelProgramLevel:
                        apiName: ChannelProgramLevel
                        keyPrefix: 0Pl
                        label: Channel Program Level
                        labelPlural: Channel Program Levels
                        nameFields:
                        - Name
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/ChannelProgramLevel
                      ChannelProgramLevelHistory:
                        apiName: ChannelProgramLevelHistory
                        keyPrefix: '017'
                        label: Channel Program Level History
                        labelPlural: Channel Program Level History
                        nameFields: []
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/ChannelProgramLevelHistory
                      ChannelProgramMember:
                        apiName: ChannelProgramMember
                        keyPrefix: 0Pm
                        label: Channel Program Member
                        labelPlural: Channel Program Members
                        nameFields:
                        - Name
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/ChannelProgramMember
                      ChannelProgramMemberHistory:
                        apiName: ChannelProgramMemberHistory
                        keyPrefix: '017'
                        label: Channel Program Member History
                        labelPlural: Channel Program Member History
                        nameFields: []
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/ChannelProgramMemberHistory
                      CommSubscription:
                        apiName: CommSubscription
                        keyPrefix: 0Xl
                        label: Communication Subscription
                        labelPlural: Communication Subscriptions
                        nameFields:
                        - Name
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/CommSubscription
                      CommSubscriptionChannelType:
                        apiName: CommSubscriptionChannelType
                        keyPrefix: 0eB
                        label: Communication Subscription Channel Type
                        labelPlural: Communication Subscription Channel Types
                        nameFields:
                        - Name
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/CommSubscriptionChannelType
                      CommSubscriptionChannelTypeHistory:
                        apiName: CommSubscriptionChannelTypeHistory
                        keyPrefix: '017'
                        label: Communication Subscription Channel Type  History
                        labelPlural: Communication Subscription Channel Type  History
                        nameFields: []
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/CommSubscriptionChannelTypeHistory
                      CommSubscriptionHistory:
                        apiName: CommSubscriptionHistory
                        keyPrefix: '017'
                        label: Communication Subscription  History
                        labelPlural: Communication Subscription  History
                        nameFields: []
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/CommSubscriptionHistory
                      ConsumptionRate:
                        apiName: ConsumptionRate
                        keyPrefix: 0Mo
                        label: Consumption Rate
                        labelPlural: Consumption Rates
                        nameFields:
                        - Name
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/ConsumptionRate
                      ConsumptionRateHistory:
                        apiName: ConsumptionRateHistory
                        keyPrefix: '017'
                        label: Consumption Rate History ID
                        labelPlural: Consumption Rate History ID
                        nameFields: []
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/ConsumptionRateHistory
                      ConsumptionSchedule:
                        apiName: ConsumptionSchedule
                        keyPrefix: 0Mh
                        label: Consumption Schedule
                        labelPlural: Consumption Schedules
                        nameFields:
                        - Name
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/ConsumptionSchedule
                      ConsumptionScheduleHistory:
                        apiName: ConsumptionScheduleHistory
                        keyPrefix: '017'
                        label: Consumption Schedule History ID
                        labelPlural: Consumption Schedule History ID
                        nameFields: []
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/ConsumptionScheduleHistory
                      Contact:
                        apiName: Contact
                        keyPrefix: '003'
                        label: Contact
                        labelPlural: Contacts
                        nameFields:
                        - FirstName
                        - LastName
                        - Name
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/Contact
                      ContactHistory:
                        apiName: ContactHistory
                        keyPrefix: '017'
                        label: Contact History
                        labelPlural: Contact History
                        nameFields: []
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/ContactHistory
                      ContactPointTypeConsent:
                        apiName: ContactPointTypeConsent
                        keyPrefix: 0ZY
                        label: Contact Point Type Consent
                        labelPlural: Contact Point Type Consents
                        nameFields:
                        - Name
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/ContactPointTypeConsent
                      ContactPointTypeConsentHistory:
                        apiName: ContactPointTypeConsentHistory
                        keyPrefix: '017'
                        label: Contact Point Type Consent  History
                        labelPlural: Contact Point Type Consent  History
                        nameFields: []
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/ContactPointTypeConsentHistory
                      ContactRequest:
                        apiName: ContactRequest
                        keyPrefix: 0Tz
                        label: Contact Request
                        labelPlural: Contact Requests
                        nameFields:
                        - Name
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/ContactRequest
                      ContentDocument:
                        apiName: ContentDocument
                        keyPrefix: 069
                        label: File
                        labelPlural: Files
                        nameFields:
                        - Title
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/ContentDocument
                      ContentDocumentHistory:
                        apiName: ContentDocumentHistory
                        keyPrefix: '017'
                        label: Content Document History
                        labelPlural: Content Document History
                        nameFields: []
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/ContentDocumentHistory
                      ContentDocumentLink:
                        apiName: ContentDocumentLink
                        keyPrefix: 06A
                        label: Content Document Link
                        labelPlural: Content Document Link
                        nameFields: []
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/ContentDocumentLink
                      ContentVersion:
                        apiName: ContentVersion
                        keyPrefix: 068
                        label: File
                        labelPlural: Files
                        nameFields:
                        - Title
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/ContentVersion
                      ContentVersionHistory:
                        apiName: ContentVersionHistory
                        keyPrefix: '017'
                        label: Content Version History
                        labelPlural: Content Version History
                        nameFields: []
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/ContentVersionHistory
                      ContentWorkspace:
                        apiName: ContentWorkspace
                        keyPrefix: 058
                        label: Library
                        labelPlural: Libraries
                        nameFields:
                        - Name
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/ContentWorkspace
                      Contract:
                        apiName: Contract
                        keyPrefix: '800'
                        label: Contract
                        labelPlural: Contracts
                        nameFields:
                        - ContractNumber
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/Contract
                      ContractContactRole:
                        apiName: ContractContactRole
                        keyPrefix: 02a
                        label: Contract Contact Role
                        labelPlural: Contract Contact Role
                        nameFields: []
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/ContractContactRole
                      ContractHistory:
                        apiName: ContractHistory
                        keyPrefix: '017'
                        label: Contract History
                        labelPlural: Contract History
                        nameFields: []
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/ContractHistory
                      CredentialStuffingEventStore:
                        apiName: CredentialStuffingEventStore
                        keyPrefix: 0fj
                        label: Credential Stuffing Event Store
                        labelPlural: Credential Stuffing Event Stores
                        nameFields:
                        - CredentialStuffingEventNumber
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/CredentialStuffingEventStore
                      CspTrustedSite:
                        apiName: CspTrustedSite
                        keyPrefix: 08y
                        label: Trusted URL
                        labelPlural: Trusted URLs
                        nameFields:
                        - DeveloperName
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/CspTrustedSite
                      Customer:
                        apiName: Customer
                        keyPrefix: 6
                        label: Customer
                        labelPlural: Customers
                        nameFields:
                        - Name
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/Customer
                      DandBCompany:
                        apiName: DandBCompany
                        keyPrefix: 06E
                        label: D&B Company
                        labelPlural: D&B Companies
                        nameFields:
                        - Name
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/DandBCompany
                      DataUseLegalBasis:
                        apiName: DataUseLegalBasis
                        keyPrefix: 0ZT
                        label: Data Use Legal Basis
                        labelPlural: Data Use Legal Bases
                        nameFields:
                        - Name
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/DataUseLegalBasis
                      DataUseLegalBasisHistory:
                        apiName: DataUseLegalBasisHistory
                        keyPrefix: '017'
                        label: Data Use Legal Basis  History
                        labelPlural: Data Use Legal Basis  History
                        nameFields: []
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/DataUseLegalBasisHistory
                      DataUsePurpose:
                        apiName: DataUsePurpose
                        keyPrefix: 0ZW
                        label: Data Use Purpose
                        labelPlural: Data Use Purposes
                        nameFields:
                        - Name
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/DataUsePurpose
                      DataUsePurposeHistory:
                        apiName: DataUsePurposeHistory
                        keyPrefix: '017'
                        label: Data Use Purpose  History
                        labelPlural: Data Use Purpose  History
                        nameFields: []
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/DataUsePurposeHistory
                      Dataweave_Key_Mapping__mdt:
                        apiName: Dataweave_Key_Mapping__mdt
                        keyPrefix: m00
                        label: Dataweave Key Mapping
                        labelPlural: Dataweave Key Mappings
                        nameFields:
                        - DeveloperName
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/Dataweave_Key_Mapping__mdt
                      Dataweave_Mapping__mdt:
                        apiName: Dataweave_Mapping__mdt
                        keyPrefix: m01
                        label: Dataweave Mapping
                        labelPlural: Dataweave Mappings
                        nameFields:
                        - DeveloperName
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/Dataweave_Mapping__mdt
                      DelegatedAccount:
                        apiName: DelegatedAccount
                        keyPrefix: 0du
                        label: External Managed Account
                        labelPlural: External Managed Accounts
                        nameFields:
                        - Name
                        objectInfoUrl: /services/data/v58.0/ui-api/object-info/DelegatedAccount
                      DelegatedAccountHistory:
                        apiName: DelegatedAccountHistory
                        keyPrefix: '017'
                        label: External Managed Account History
                        labelPlural: External Managed Account History
                        name

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