Fenergo External Data Portal Outreach Query — OpenAPI 3.0.4 contract published by Fenergo for the externaloutreachquery service of the Fen-X SaaS platform, carrying 4 path(s) and 4 operation(s). Harvested verbatim from Fenergo's own published specification endpoint.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/externaloutreachquery-v1-0"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
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.
A second provider on the same verified email joins the account you already have.
{
"openapi": "3.0.4",
"info": {
"title": "Fenergo External Data Portal Outreach Query",
"description": "External Data Portal Outreach Query API provides methods related to the Portal Outreach. Use the External Data Portal Outreach Query API to retrieve Outreach Entity Data.",
"version": "1.0"
},
"servers": [
{
"url": "/externaloutreachquery"
}
],
"paths": {
"/api/association/root/{EntityId}/journey/{JourneyId}": {
"get": {
"tags": [
"Association"
],
"summary": "Get all Associations by Journey Id",
"description": "\nThis method returns a list of associations for a given journey<br /><br /><b>Required permissions:</b><br />Following permissions are required: AssociationAccess",
"operationId": "GetAssociations",
"parameters": [
{
"name": "JourneyId",
"in": "path",
"description": "The UiD of a journey that the associations belong to",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "EntityId",
"in": "path",
"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": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssociationDtoIEnumerableServiceResponse"
}
}
}
},
"400": {
"description": "Invalid request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"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"
}
]
}
}
}
}
}
}
},
"/api/association/existingassociatedentitycomments/{journeyId}": {
"get": {
"tags": [
"Association"
],
"summary": "Get all Existing Associated Entities Comments by Journey Id",
"description": "\nThis method returns a list of existing associated entity comments for a given journey<br /><br /><b>Required permissions:</b><br />Following permissions are required: AssociationAccess",
"operationId": "GetAssociatedEntityComments",
"parameters": [
{
"name": "journeyId",
"in": "path",
"description": "Id of a journey that associated entities comments belong to",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"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": {
"400": {
"description": "Invalid request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExistingAssociatedEntityCommentsDtoServiceResponse"
}
}
}
},
"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"
}
]
}
}
}
}
}
}
},
"/api/data/getdatabyjourneyid/{journeyId}": {
"get": {
"tags": [
"Data"
],
"summary": "Get outreach entity data by journey id",
"description": "\nReturns outreach entity data for a given journey id.<br /><br /><b>Required permissions:</b><br />At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch",
"operationId": "GetDataByJourneyId",
"parameters": [
{
"name": "journeyId",
"in": "path",
"description": "Journey id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"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": "Success. Outreach entity data is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataDtoServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Outreach entity data with given journey id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"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"
}
]
}
}
}
}
}
}
},
"/api/related-data/getlist": {
"post": {
"tags": [
"RelatedData"
],
"summary": "Get list of outreach related Data",
"description": "\nReturns the list of related data.<br /><br /><b>Required permissions:</b><br />At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch",
"operationId": "GetRelatedDataList",
"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": "Query related data request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/RelatedDataListQueryDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"200": {
"description": "Success. The list of related data is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataDtoListServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"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"
}
]
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AssociationDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The UiD of the association model",
"format": "uuid",
"example": "118313c6-91e6-4b05-a537-5a1ab906418f"
},
"sourceId": {
"type": "string",
"description": "The UiD of the Parent Entity",
"format": "uuid",
"example": "2920b7a7-7336-4fb1-82b7-1d691b8367fa"
},
"targetId": {
"type": "string",
"description": "The UiD of the Child Entity",
"format": "uuid",
"example": "6b399cff-6e35-42a0-aaf0-69a94a008636"
},
"type": {
"type": "string",
"description": "The type of association",
"nullable": true,
"example": "Shareholder"
},
"journeyId": {
"type": "string",
"description": "The UiD of the Journey that this association was created",
"format": "uuid",
"example": "4a056330-18d2-4ec1-8b1e-c959ed4b5f12"
},
"isVerified": {
"type": "boolean",
"description": "Annotates whether the association has been validated",
"example": true
},
"createdBySnapshot": {
"type": "boolean",
"description": "Annotates whether the association was created by the outreach snapshot process",
"example": false
},
"ownershipPercentage": {
"type": "number",
"description": "The percentage amount of the target entity owned by the source entity\n(optional)",
"format": "double",
"nullable": true,
"example": 5.007
},
"properties": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"description": "A list of custom properties that describe the association",
"nullable": true,
"example": [
{
"Ownership Percentage": 15
},
{
"CountryOfIncorporation": "Ireland"
}
]
}
},
"additionalProperties": false,
"description": "The metadata of an association between two entities"
},
"AssociationDtoIEnumerableServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AssociationDto"
},
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"CollectionDto": {
"type": "object",
"properties": {
"isValid": {
"type": "boolean"
},
"properties": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"nullable": true
},
"propertiesInfo": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/CollectionPropertyInfoDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"CollectionPropertyDto": {
"allOf": [
{
"$ref": "#/components/schemas/PropertyDto"
},
{
"type": "object",
"properties": {
"dataGroupId": {
"type": "string",
"format": "uuid"
},
"dataGroupVersionNumber": {
"type": "integer",
"format": "int32",
"nullable": true
},
"collections": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/CollectionDto"
},
"nullable": true
}
},
"additionalProperties": false
}
]
},
"CollectionPropertyInfoDto": {
"type": "object",
"properties": {
"valueId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"CustomPropertyDto": {
"allOf": [
{
"$ref": "#/components/schemas/PropertyDto"
},
{
"type": "object",
"properties": {
"customTypeId": {
"type": "string",
"format": "uuid"
},
"properties": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/PropertyDto"
},
"nullable": true
}
},
"additionalProperties": false
}
]
},
"DataDto": {
"type": "object",
"properties": {
"sourceEntityId": {
"type": "string",
"description": "Source entity id",
"format": "uuid",
"example": "bb88430f-48ec-46de-92dc-905876e0e8eb"
},
"sourceEntityVersion": {
"type": "integer",
"description": "Source entity version",
"format": "int32",
"example": 1
},
"id": {
"type": "string",
"description": "Entity draft id",
"format": "uuid",
"example": "8d631fde-505e-4101-a7cd-83ab6c054a5a"
},
"journeyId": {
"type": "string",
"description": "Journey id",
"format": "uuid",
"example": "7c4bc3ff-9d5b-4ccd-839b-637c227b1c65"
},
"type": {
"type": "string",
"description": "Entity draft type",
"nullable": true,
"example": "Individual"
},
"properties": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/PropertyDto"
},
"description": "Entity draft properties",
"nullable": true
},
"status": {
"type": "string",
"description": "Status",
"nullable": true,
"example": "InProgress"
},
"created": {
"type": "string",
"description": "Created date",
"format": "date-time",
"nullable": true,
"example": "2021-01-01T14:48:00.000Z"
},
"jurisdictions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VersionedJurisdictionDto"
},
"description": "List of Jurisdictions associated with EntityDraft",
"nullable": true
},
"version": {
"type": "integer",
"description": "Version number for given EntityDraft",
"format": "int32",
"example": 1
},
"markedForDeletion": {
"type": "boolean",
"description": "When true, a portal user has requested removal of this related party.\nThe related party is not hard-deleted; back-office reviews and approves the request.\nOnly ever set for related-party records; always false for the main journey entity."
},
"removalComment": {
"type": "string",
"description": "Optional free-text comment supplied by the portal user when requesting removal of this related party.",
"nullable": true
},
"createdBySnapshot": {
"type": "boolean",
"description": "When true, this related party was copied into the outreach store by the snapshot\ntaken at the start of the outreach stage, rather than added during outreach.\nOnly ever set for related-party records; always false for the main journey entity."
}
},
"additionalProperties": false,
"description": "Response DTO representing entity draft data"
},
"DataDtoListServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataDto"
},
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"DataDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/DataDto"
}
],
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"ExistingAssociatedEntityCommentsDto": {
"type": "object",
"properties": {
"associatedEntityIdsComments": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"description": "EntityId Comments Dictionary",
"nullable": true,
"example": {
"7c4bc3ff-9d5b-4ccd-839b-637c227b1c65": "This is not valid association",
"6c4bc3ff-9d5b-4ccd-839b-637c227b1c65": "This is old association"
}
},
"version": {
"type": "integer",
"description": "Version number for given Object",
"format": "int32",
"example": 1
}
},
"additionalProperties": false,
"description": "Comment for Existing Associated Entity in the System"
},
"ExistingAssociatedEntityCommentsDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ExistingAssociatedEntityCommentsDto"
}
],
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"ObjectServiceResponse": {
"type": "object",
"properties": {
"data": {
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"PropertyDto": {
"required": [
"discriminator"
],
"type": "object",
"properties": {
"discriminator": {
"allOf": [
{
"$ref": "#/components/schemas/PropertyType"
}
],
"readOnly": true
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/PropertyType"
}
],
"readOnly": true
},
"isValid": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false,
"discriminator": {
"propertyName": "discriminator",
# --- truncated at 32 KB (39 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/fenergo/refs/heads/main/openapi/fenergo-externaloutreachquery-v1-0-openapi.json