Coveo

Coveo Salesforce Organizations API

The Salesforce Organizations API from Coveo — 3 operation(s) for salesforce organizations.

Documentation GitHub OpenAPI

Operations 3

DELETE /rest/salesforce/schema/ Flushes the Cached Data for a Salesforce Organization #

POST /rest/salesforce/schema/objects Loads the Object Data for a List of Salesforce Objects. #

GET /rest/salesforce/schema/organization Loads the Organization Data for a Salesforce Organization. #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/coveo-salesforce-organizations-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Coveo Schema Service Salesforce Organizations API
  version: 1.0.0
  description: Documentation for Coveo Schema Service
  termsOfService: http://www.coveo.com/en/support/terms-agreements
  contact:
    name: ''
    url: ''
    email: support@coveo.com
  license:
    name: ''
    url: ''
servers:
- url: https://platform.cloud.coveo.com
  description: Coveo public API endpoint
tags:
- name: Salesforce Organizations
paths:
  /rest/salesforce/schema/:
    delete:
      operationId: flushCache
      summary: Flushes the Cached Data for a Salesforce Organization
      tags:
      - Salesforce Organizations
      deprecated: false
      parameters:
      - name: instanceUri
        description: The instance URI of the Salesforce organization
        required: true
        in: query
        schema:
          type: string
      - name: sessionId
        description: Deprecated, use the appropriate 'X-Salesforce-Session-ID' header instead
        required: true
        in: query
        schema:
          type: string
      - name: version
        description: 'The schema version to use. Allowed values: ["0" (CloudV1), "1" (Legacy), "2" (Current)]'
        required: false
        in: query
        schema:
          type: string
          default: '2'
      - name: presets
        description: 'The schema presets to apply. Allowed values: ["servicecloud", "knowledge", "content", "chatter"]'
        required: false
        in: query
        schema:
          type: string
      - name: X-Salesforce-Session-ID
        description: The Salesforce session ID to use
        required: true
        in: header
        schema:
          type: string
      responses:
        '200':
          description: No response
      security:
      - oauth2:
        - full
  /rest/salesforce/schema/objects:
    post:
      operationId: loadObjects
      summary: Loads the Object Data for a List of Salesforce Objects.
      tags:
      - Salesforce Organizations
      deprecated: false
      parameters:
      - name: instanceUri
        description: The instance URI of the Salesforce organization
        required: true
        in: query
        schema:
          type: string
      - name: sessionId
        description: Deprecated, use the appropriate 'X-Salesforce-Session-ID' header instead
        required: true
        in: query
        schema:
          type: string
      - name: version
        description: 'The schema version to use. Allowed values: ["0" (CloudV1), "1" (Legacy), "2" (Current)]'
        required: false
        in: query
        schema:
          type: string
          default: '2'
      - name: presets
        description: 'The schema presets to apply. Allowed values: ["servicecloud", "knowledge", "content", "chatter"]'
        required: false
        in: query
        schema:
          type: string
      - name: X-Salesforce-Session-ID
        description: The Salesforce session ID to use
        required: true
        in: header
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ObjectDescription'
      security:
      - oauth2:
        - full
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoadObjectsParams'
        required: true
  /rest/salesforce/schema/organization:
    get:
      operationId: loadOrganization
      summary: Loads the Organization Data for a Salesforce Organization.
      tags:
      - Salesforce Organizations
      deprecated: false
      parameters:
      - name: instanceUri
        description: The instance URI of the Salesforce organization
        required: true
        in: query
        schema:
          type: string
      - name: sessionId
        description: Deprecated, use the appropriate 'X-Salesforce-Session-ID' header instead
        required: true
        in: query
        schema:
          type: string
      - name: version
        description: 'The schema version to use. Allowed values: ["0" (CloudV1), "1" (Legacy), "2" (Current)]'
        required: false
        in: query
        schema:
          type: string
          default: '2'
      - name: presets
        description: 'The schema presets to apply. Allowed values: ["servicecloud", "knowledge", "content", "chatter"]'
        required: false
        in: query
        schema:
          type: string
      - name: X-Salesforce-Session-ID
        description: The Salesforce session ID to use
        required: true
        in: header
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationDescription'
      security:
      - oauth2:
        - full
components:
  schemas:
    DataCategoryGroupDescription:
      type: object
      properties:
        name:
          type: string
        values:
          type: array
          items:
            $ref: '#/components/schemas/DataCategoryValueDescription'
      required:
      - name
      - values
    OrganizationDescription:
      type: object
      properties:
        organizationId:
          type: string
        objects:
          type: array
          items:
            $ref: '#/components/schemas/ObjectSummary'
        knowledgeLanguages:
          type: array
          items:
            type: string
        dataCategoryGroups:
          type: array
          items:
            $ref: '#/components/schemas/DataCategoryGroupDescription'
      required:
      - organizationId
      - objects
      - knowledgeLanguages
      - dataCategoryGroups
    ObjectSummary:
      type: object
      properties:
        objectType:
          type: string
        label:
          type: string
        searchable:
          type: boolean
        queryable:
          type: boolean
        replicateable:
          type: boolean
        keyPrefix:
          type: string
        isCustomObject:
          type: boolean
        isKnowledgeObject:
          type: boolean
        hasCustomFileType:
          type: boolean
        shouldIndexByDefault:
          type: boolean
      required:
      - objectType
      - label
      - searchable
      - queryable
      - replicateable
      - isCustomObject
      - isKnowledgeObject
      - hasCustomFileType
      - shouldIndexByDefault
    MappingDescription:
      type: object
      properties:
        extractionMethod:
          type: string
        content:
          type: string
        fieldTypeHint:
          type: string
      required:
      - extractionMethod
      - content
    RelationshipDescription:
      type: object
      properties: {}
    LoadObjectsParams:
      type: object
      properties:
        names:
          description: The object names to load.
          type: array
          items:
            type: string
      required:
      - names
    ObjectDescription:
      type: object
      properties:
        objectType:
          type: string
        fieldsByName:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/FieldDescription'
        fieldsByCoveoName:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/FieldDescription'
        fieldsBySalesforceName:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/FieldDescription'
        relationshipsByName:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/RelationshipDescription'
        label:
          type: string
        searchable:
          type: boolean
        queryable:
          type: boolean
        replicateable:
          type: boolean
        keyPrefix:
          type: string
        isCustomObject:
          type: boolean
        isKnowledgeObject:
          type: boolean
        hasCustomFileType:
          type: boolean
        shouldIndexByDefault:
          type: boolean
        titleFields:
          type: array
          items:
            type: string
        fields:
          type: array
          items:
            $ref: '#/components/schemas/FieldDescription'
        relationships:
          type: array
          items:
            $ref: '#/components/schemas/RelationshipDescription'
      required:
      - objectType
      - label
      - searchable
      - queryable
      - replicateable
      - isCustomObject
      - isKnowledgeObject
      - hasCustomFileType
      - shouldIndexByDefault
      - titleFields
      - fields
      - relationships
      - fieldsByName
      - fieldsByCoveoName
      - fieldsBySalesforceName
      - relationshipsByName
    FieldDescription:
      type: object
      properties:
        name:
          type: string
        coveoName:
          type: string
        salesforceName:
          type: string
        label:
          type: string
        kind:
          type: string
        custom:
          type: boolean
        virtual:
          type: boolean
        retrievable:
          type: boolean
        filterable:
          type: boolean
        sortable:
          type: boolean
        multiValue:
          type: boolean
        mandatory:
          type: boolean
        shouldIndexByDefault:
          type: boolean
        dataCategoryGroup:
          type: string
        mapping:
          $ref: '#/components/schemas/MappingDescription'
        legacyFieldInformation:
          $ref: '#/components/schemas/LegacyFieldInformation'
      required:
      - name
      - coveoName
      - salesforceName
      - label
      - kind
      - custom
      - virtual
      - retrievable
      - filterable
      - sortable
      - multiValue
      - mandatory
      - shouldIndexByDefault
    LegacyFieldInformation:
      type: object
      properties:
        relationshipName:
          type: string
        relationshipNameField:
          type: string
        polymorphic:
          type: boolean
        referenceTypes:
          type: array
          items:
            type: string
      required:
      - relationshipName
      - relationshipNameField
      - polymorphic
      - referenceTypes
    DataCategoryValueDescription:
      type: object
      properties:
        name:
          type: string
        label:
          type: string
      required:
      - name
      - label
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        implicit:
          scopes:
            full: full
          authorizationUrl: https://platform.cloud.coveo.com/oauth/authorize
      description: OAuth2

Coveo Salesforce Organizations API

Operations 3

Documentation

Specifications

Schemas & Data

Other Resources