Coveo Source API — Sources

naftiko: 1.0.0-alpha2
info:
  label: Coveo Source API — Sources
  description: 'Coveo Source API — Sources. 47 operations. Lead operation: Get a Subset of Sources for an Organization. Self-contained
    Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Source
  - Sources
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COVEO_API_KEY: COVEO_API_KEY
capability:
  consumes:
  - type: http
    namespace: source-sources
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Source API — Sources business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_API_KEY}}'
    resources:
    - name: rest-organizations-organizationId-sources
      path: /rest/organizations/{organizationId}/sources
      operations:
      - name: getsources
        method: GET
        description: Get a Subset of Sources for an Organization
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: page
          in: query
          type: integer
        - name: perPage
          in: query
          type: integer
        - name: filter
          in: query
          type: string
          description: Optional filter string. Must be at least 2 characters long to be applied.
        - name: sortingType
          in: query
          type: string
        - name: sortingOrder
          in: query
          type: string
        - name: writeAccessOnly
          in: query
          type: boolean
        - name: filterStatusType
          in: query
          type: string
        - name: filterLastOperationType
          in: query
          type: string
        - name: filterLastOperationResultType
          in: query
          type: string
        - name: filterHostType
          in: query
          type: string
        - name: stringFilterType
          in: query
          type: string
      - name: createsource
        method: POST
        description: Create a Source from Simple Configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: updateSecurityProviders
          in: query
          type: boolean
        - name: rebuild
          in: query
          type: boolean
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-sources-document-configuration-default
      path: /rest/organizations/{organizationId}/sources/document/configuration/default
      operations:
      - name: getdefaultdocumentconfiguration
        method: GET
        description: Get the Default Document Configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: defaultDocumentConfigurationType
          in: query
          type: string
    - name: rest-organizations-organizationId-sources-fields
      path: /rest/organizations/{organizationId}/sources/fields
      operations:
      - name: getfields1
        method: GET
        description: Get All Fields for an Organization
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: sourceId
          in: query
          type: string
        - name: includeMappings
          in: query
          type: boolean
      - name: createfield
        method: POST
        description: Creates a Field for an Organization
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-sources-fields-batch-create
      path: /rest/organizations/{organizationId}/sources/fields/batch/create
      operations:
      - name: createfields
        method: POST
        description: Creates Fields for an Organization
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-sources-fields-batch-delete
      path: /rest/organizations/{organizationId}/sources/fields/batch/delete
      operations:
      - name: removefields
        method: DELETE
        description: Removes Fields from an Organization
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: fields
          in: query
          type: array
          required: true
    - name: rest-organizations-organizationId-sources-fields-batch-update
      path: /rest/organizations/{organizationId}/sources/fields/batch/update
      operations:
      - name: updatefields
        method: PUT
        description: Update a Field for an Organization
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-sources-fields-fieldId
      path: /rest/organizations/{organizationId}/sources/fields/{fieldId}
      operations:
      - name: getfield
        method: GET
        description: Get a Single Field for an Organization
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: fieldId
          in: path
          type: string
          required: true
        - name: includeMappings
          in: query
          type: boolean
      - name: updatefield
        method: PUT
        description: Update a Field for an Organization
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: fieldId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: removefield
        method: DELETE
        description: Removes a Specific Field from an Organization
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: fieldId
          in: path
          type: string
          required: true
    - name: rest-organizations-organizationId-sources-page-fields
      path: /rest/organizations/{organizationId}/sources/page/fields
      operations:
      - name: getfields2
        method: GET
        description: Get a Page of Fields for an Organization
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: projectId
          in: query
          type: string
        - name: includeMappings
          in: query
          type: boolean
        - name: type
          in: query
          type: string
        - name: filter
          in: query
          type: string
          description: Optional filter string. Must be at least 2 characters long to be applied.
        - name: sortBy
          in: query
          type: string
        - name: order
          in: query
          type: string
        - name: page
          in: query
          type: integer
        - name: perPage
          in: query
          type: integer
        - name: origin
          in: query
          type: string
    - name: rest-organizations-organizationId-sources-pages
      path: /rest/organizations/{organizationId}/sources/pages
      operations:
      - name: getsourcesandpageinformations
        method: GET
        description: Get a Page Containing a Subset of Sources for an Organization.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: page
          in: query
          type: integer
        - name: perPage
          in: query
          type: integer
        - name: filter
          in: query
          type: string
          description: Optional filter string. Must be at least 2 characters long to be applied.
        - name: sortingType
          in: query
          type: string
        - name: sortingOrder
          in: query
          type: string
        - name: writeAccessOnly
          in: query
          type: boolean
        - name: filterStatusType
          in: query
          type: string
        - name: filterLastOperationType
          in: query
          type: string
        - name: filterLastOperationResultType
          in: query
          type: string
        - name: filterHostType
          in: query
          type: string
        - name: stringFilterType
          in: query
          type: string
    - name: rest-organizations-organizationId-sources-pages-ids
      path: /rest/organizations/{organizationId}/sources/pages/ids
      operations:
      - name: getsourcesandpageinformationsbyids
        method: POST
        description: Get a Page Containing a Subset of Sources by Ids for an Organization.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: page
          in: query
          type: integer
        - name: perPage
          in: query
          type: integer
        - name: filter
          in: query
          type: string
          description: Optional filter string. Must be at least 2 characters long to be applied.
        - name: sortingType
          in: query
          type: string
        - name: sortingOrder
          in: query
          type: string
        - name: writeAccessOnly
          in: query
          type: boolean
        - name: filterStatusType
          in: query
          type: string
        - name: filterLastOperationType
          in: query
          type: string
        - name: filterLastOperationResultType
          in: query
          type: string
        - name: filterHostType
          in: query
          type: string
        - name: stringFilterType
          in: query
          type: string
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-sources-pages-project
      path: /rest/organizations/{organizationId}/sources/pages/project
      operations:
      - name: getsourcesandpageinformationsprojectid
        method: GET
        description: Get a Page Containing a Subset of Sources Part of a Project Id. with the Total Number of Sources and
          the Total Number of Pages
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: page
          in: query
          type: integer
        - name: perPage
          in: query
          type: integer
        - name: filter
          in: query
          type: string
          description: Optional filter string. Must be at least 2 characters long to be applied.
        - name: projectId
          in: query
          type: string
        - name: sortingType
          in: query
          type: string
        - name: sortingOrder
          in: query
          type: string
        - name: writeAccessOnly
          in: query
          type: boolean
        - name: filterStatusType
          in: query
          type: string
        - name: filterLastOperationType
          in: query
          type: string
        - name: filterLastOperationResultType
          in: query
          type: string
        - name: filterHostType
          in: query
          type: string
        - name: stringFilterType
          in: query
          type: string
    - name: rest-organizations-organizationId-sources-raw
      path: /rest/organizations/{organizationId}/sources/raw
      operations:
      - name: createrawsource
        method: POST
        description: Create a Source from Raw Configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: updateSecurityProviders
          in: query
          type: boolean
        - name: rebuild
          in: query
          type: boolean
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-sources-raw-all
      path: /rest/organizations/{organizationId}/sources/raw/all
      operations:
      - name: getallrawsources
        method: GET
        description: Get the Raw Configuration of All Sources
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: page
          in: query
          type: integer
        - name: pageSize
          in: query
          type: integer
        - name: includeMappings
          in: query
          type: boolean
    - name: rest-organizations-organizationId-sources-sourceId
      path: /rest/organizations/{organizationId}/sources/{sourceId}
      operations:
      - name: getsource
        method: GET
        description: Get a Single Source
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: sourceId
          in: path
          type: string
          required: true
      - name: updatesource
        method: PUT
        description: Update a Source from Simple Configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: sourceId
          in: path
          type: string
          required: true
        - name: updateSecurityProviders
          in: query
          type: boolean
        - name: rebuild
          in: query
          type: boolean
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletesource
        method: DELETE
        description: Delete a Source
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: sourceId
          in: path
          type: string
          required: true
    - name: rest-organizations-organizationId-sources-sourceId-applyChanges
      path: /rest/organizations/{organizationId}/sources/{sourceId}/applyChanges
      operations:
      - name: applychanges
        method: POST
        description: Apply Pending Changes on a Source
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: sourceId
          in: path
          type: string
          required: true
    - name: rest-organizations-organizationId-sources-sourceId-configuration-salesforce-evic
      path: /rest/organizations/{organizationId}/sources/{sourceId}/configuration/salesforce/evict
      operations:
      - name: evictschemaforsource
        method: POST
        description: Evict the Salesforce Schema of a Source.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: sourceId
          in: path
          type: string
          required: true
    - name: rest-organizations-organizationId-sources-sourceId-configuration-salesforce-obje
      path: /rest/organizations/{organizationId}/sources/{sourceId}/configuration/salesforce/objects/{objectName}
      operations:
      - name: getsalesforceobjectforsource
        method: GET
        description: Get an Object Fields for a Given Source.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: sourceId
          in: path
          type: string
          required: true
        - name: objectName
          in: path
          type: string
          required: true
        - name: relationships
          in: query
          type: string
    - name: rest-organizations-organizationId-sources-sourceId-configuration-salesforce-obje
      path: /rest/organizations/{organizationId}/sources/{sourceId}/configuration/salesforce/objects/{objectName}/fields
      operations:
      - name: getsalesforcefieldsforsource
        method: GET
        description: Get an Object Fields for a Given Source.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: sourceId
          in: path
          type: string
          required: true
        - name: objectName
          in: path
          type: string
          required: true
    - name: rest-organizations-organizationId-sources-sourceId-configuration-salesforce-obje
      path: /rest/organizations/{organizationId}/sources/{sourceId}/configuration/salesforce/objects/{objectName}/{relationshipName}
      operations:
      - name: getsalesforcerelationshipsforsource
        method: GET
        description: Get a Relationship for a Given Source and Object.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: sourceId
          in: path
          type: string
          required: true
        - name: objectName
          in: path
          type: string
          required: true
        - name: relationshipName
          in: path
          type: string
          required: true
    - name: rest-organizations-organizationId-sources-sourceId-configuration-snapshot
      path: /rest/organizations/{organizationId}/sources/{sourceId}/configuration/snapshot
      operations:
      - name: getsourcesnapshot
        method: GET
        description: Get the Snapshot of the Source Configuration at the Provided Activity.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: sourceId
          in: path
          type: string
          description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`
          required: true
        - name: activityId
          in: query
          type: string
          required: true
    - name: rest-organizations-organizationId-sources-sourceId-disable
      path: /rest/organizations/{organizationId}/sources/{sourceId}/disable
      operations:
      - name: disable
        method: POST
        description: Disable Schedules on a Source
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: sourceId
          in: path
          type: string
          required: true
    - name: rest-organizations-organizationId-sources-sourceId-duplicate
      path: /rest/organizations/{organizationId}/sources/{sourceId}/duplicate
      operations:
      - name: duplicatesource
        method: POST
        description: Duplicate a Source
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: sourceId
          in: path
          type: string
          required: true
        - name: newSourceName
          in: query
          type: string
          required: true
        - name: logicalIndexId
          in: query
          type: string
    - name: rest-organizations-organizationId-sources-sourceId-enable
      path: /rest/organizations/{organizationId}/sources/{sourceId}/enable
      operations:
      - name: enable
        method: POST
        description: Enable Schedules on a Source
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: sourceId
          in: path
          type: string
          required: true
    - name: rest-organizations-organizationId-sources-sourceId-fullRefresh
      path: /rest/organizations/{organizationId}/sources/{sourceId}/fullRefresh
      operations:
      - name: fullrefresh
        method: POST
        description: Apply a Full Refresh Operation on a Source
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: sourceId
          in: path
          type: string
          required: true
    - name: rest-organizations-organizationId-sources-sourceId-incrementalRefresh
      path: /rest/organizations/{organizationId}/sources/{sourceId}/incrementalRefresh
      operations:
      - name: incrementalrefresh
        method: POST
        description: Apply an Incremental Refresh Operation on a Source
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: sourceId
          in: path
          type: string
          required: true
    - name: rest-organizations-organizationId-sources-sourceId-light
      path: /rest/organizations/{organizationId}/sources/{sourceId}/light
      operations:
      - name: getlightsource
        method: GET
        description: Get a Single Source
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: sourceId
          in: path
          type: string
          required: true
    - name: rest-organizations-organizationId-sources-sourceId-pauseRefresh
      path: /rest/organizations/{organizationId}/sources/{sourceId}/pauseRefresh
      operations:
      - name: pauserefresh
        method: POST
        description: Pause the Current Refresh Operation on a Source
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: sourceId
          in: path
          type: string
          required: true
    - name: rest-organizations-organizationId-sources-sourceId-permissions-update
      path: /rest/organizations/{organizationId}/sources/{sourceId}/permissions/update
      operations:
      - name: updatesourcepermissions
        method: PUT
        description: Update Source Permissions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: sourceId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-sources-sourceId-pushRefresh
      path: /rest/organizations/{organizationId}/sources/{sourceId}/pushRefresh
      operations:
      - name: setpushrefreshstatus
        method: POST
        description: Sets the Refreshing State of a Push Source
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: sourceId
          in: path
          type: string
          required: true
        - name: activityOperation
          in: query
          type: string
          required: true
    - name: rest-organizations-organizationId-sources-sourceId-raw
      path: /rest/organizations/{organizationId}/sources/{sourceId}/raw
      operations:
      - name: getrawsource
        method: GET
        description: Get the Raw Configuration of a Source
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: sourceId
          in: path
          type: string
          required: true
        - name: includeMappings
          in: query
          type: boolean
      - name: updaterawsource
        method: PUT
        description: Update a Source from Raw Configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: sourceId
          in: path
          type: string
          required: true
        - name: updateSecurityProviders
          in: query
          type: boolean
        - name: rebuild
          in: query
          type: boolean
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-sources-sourceId-rebuild
      path: /rest/organizations/{organizationId}/sources/{sourceId}/rebuild
      operations:
      - name: rebuild
        method: POST
        description: Apply a Rebuild Operation on a Source
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: sourceId
          in: path
          type: string
          required: true
    - name: rest-organizations-organizationId-sources-sourceId-resumeRefresh
      path: /rest/organizations/{organizationId}/sources/{sourceId}/resumeRefresh
      operations:
      - name: resumerefresh
        method: POST
        description: Resume the Current Refresh Operation on a Source
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: sourceId
          in: path
          type: string
          required: true
    - name: rest-organizations-organizationId-sources-sourceId-schedules
      path: /rest/organizations/{organizationId}/sources/{sourceId}/schedules
      operations:
      - name: getsourceschedules
        method: GET
        description: Get All Source Schedules
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: sourceId
          in: path
          type: string
          required: true
      - name: createsourceschedule
        method: POST
        description: Create a New Schedule for the Source
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: sourceId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-sources-sourceId-schedules-scheduleId
      path: /rest/organizations/{organizationId}/sources/{sourceId}/schedules/{scheduleId}
      operations:
      - name: getsourceschedule
        method: GET
        description: Get a Source Schedule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: sourceId
          in: path
          type: string
          required: true
        - name: scheduleId
          in: path
          type: string
          required: true
      - name: updatesourceschedule
        method: PUT
        description: Update a

# --- truncated at 32 KB (84 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/capabilities/source-sources.yaml