Fenergo

Fenergo Aggregation API

The Aggregation API from Fenergo — 2 operation(s) for aggregation.

Documentation GitHub OpenAPI

Operations 2

POST /api/aggregation/saveDataAggregationResults Save Data Aggregation Results #

GET /api/aggregation/{taskId} Get aggregated company data by import request id #

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/fenergo-aggregation-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: Fenergo Aggregation API
  version: '1.0'
  description: 'Operations tagged Aggregation across 2 of this provider''s published API definitions: fenergo-externaldatacommand-v1-0-openapi.json, fenergo-externaldataquery-v1-0-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /externaldatacommand
- url: /externaldataquery
security:
- Bearer: []
tags:
- name: Aggregation
paths:
  /api/aggregation/saveDataAggregationResults:
    post:
      tags:
      - Aggregation
      summary: Save Data Aggregation Results
      description: 'This method will save Data Aggregation results.


        The method will return the status.


        Required permissions:

        Following permissions are required: ExternalDataAccess


        Required permissions:

        Following permissions are required: ExternalDataAccess'
      parameters:
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        description: Save Data Aggregation Results request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/DataAggregationHeaderDtoServiceRequest'
              description: Service request data
      responses:
        '202':
          description: Success. Import request created
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
      operationId: postApiAggregationSaveDataAggregationResults
      x-operation-id-source: derived
    servers:
    - url: /externaldatacommand
  /api/aggregation/{taskId}:
    get:
      tags:
      - Aggregation
      summary: Get aggregated company data by import request id
      description: 'This method will return aggregated company data for given import request id


        Required permissions:

        Following permissions are required: ExternalDataAccess


        Required permissions:

        Following permissions are required: ExternalDataAccess'
      operationId: GetAggregatedDataByTaskId
      parameters:
      - name: taskId
        in: path
        description: The ID of journey task
        required: true
        schema:
          type: string
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Instance of Fenergo.Nebula.ExternalData.Query.Application.Dto.DataAggregationResultDto class containing company data of aggregated entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataAggregationResultDtoServiceResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Import request with given ID does not exist
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /externaldataquery
components:
  schemas:
    ServiceResponseMessage:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
          description: The message
          example: Success
        type:
          type:
          - string
          - 'null'
          description: 'Type of the message

            One of Info, Warning, Error, Forbidden'
          example: Info
        errorCode:
          type:
          - string
          - 'null'
          description: Error Code
          example: INTERNAL_SERVER_ERROR
      additionalProperties: false
      description: The message associated to the service response
    ServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    DataAggregationHeaderDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/DataAggregationHeaderDto'
          description: The service request DTO
      additionalProperties: false
      description: Service request data
    DataAggregationHeaderDto:
      required:
      - dataAggregationFieldList
      - getId
      - profilesIds
      - taskId
      type: object
      properties:
        getId:
          minLength: 1
          type: string
          description: ID of the created Import request
          example: 300e2046-f78c-49d2-b326-afba28dc301c
        taskId:
          minLength: 1
          type: string
          description: ID of the journey task
          example: 300e2046-f78c-49d2-b326-afba28dc301c
        profilesIds:
          minItems: 1
          type: array
          items:
            type: string
          description: List of profiles ids for aggregation import
        dataAggregationFieldList:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/DataAggregationFieldDto'
          description: List of Associations with Deduplication statuses
      additionalProperties: false
      description: Class to represent deduplication statuses for all Associations
    DataAggregationFieldDto:
      type: object
      properties:
        value:
          type:
          - string
          - 'null'
        dataGroupValue:
          type:
          - array
          - 'null'
          items:
            type: object
            additionalProperties:
              $ref: '#/components/schemas/DataAggregationFieldDto'
        type:
          type:
          - string
          - 'null'
        sourceProviderId:
          type:
          - string
          - 'null'
      additionalProperties: false
    ObjectServiceResponse:
      type: object
      properties:
        data:
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    StringServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    DataAggregationResultDto:
      type: object
      properties:
        profilesIds:
          type:
          - array
          - 'null'
          items:
            type: string
            format: uuid
          description: List of profiles ids for aggregation import
        aggregatedFields:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/DataAggregationFieldValueWithSource'
          description: List of fields
        aggregatedDataGroups:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - array
            - 'null'
            items:
              type: object
              additionalProperties:
                $ref: '#/components/schemas/DataAggregationFieldValueWithSource'
          description: List of data groups
      additionalProperties: false
    DataAggregationResultDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/DataAggregationResultDto'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    DataAggregationFieldValueWithSource:
      type: object
      properties:
        value:
          type:
          - string
          - 'null'
        sourceProviderId:
          type:
          - string
          - 'null'
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header
x-refined-from:
- fenergo-externaldatacommand-v1-0-openapi.json
- fenergo-externaldataquery-v1-0-openapi.json