ecosio

ecosio Companies API

Methods for managing companies

GitHub OpenAPI

Operations 4

GET /api/v1/management/companies/{companyUuid} Get a company #
PUT /api/v1/management/companies/{companyUuid} Update a company #
GET /api/v1/management/companies Find companies #
POST /api/v1/management/companies Create a company #

Documentation

📖
Documentation
https://connect.ecosio.com/reference/messaging-api
📖
Documentation
https://connect.ecosio.com/reference/management-api-overview
📖
Documentation
https://connect.ecosio.com/reference/vertex-messaging-api

Specifications

⚙
OpenAPI
https://artifacts.apis.io/ecosio/openapi/ecosio-companies-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/ecosio/json-schema/ecosio-scenario-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/ecosio/json-schema/ecosio-connector-retrieval-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/ecosio/json-schema/ecosio-company-retrieval-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/ecosio/json-schema/ecosio-romania-einvoice-create-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/ecosio/json-schema/ecosio-romania-einvoice-update-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/ecosio/json-schema/ecosio-approval-status-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/ecosio/json-schema/ecosio-message-details-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/ecosio/json-schema/ecosio-status-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/ecosio/json-schema/ecosio-confirm-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/ecosio/json-schema/ecosio-message-list-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/ecosio/json-schema/ecosio-message-raw-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/ecosio/json-schema/ecosio-delivery-request-schema.json

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/ecosio:ecosio-companies-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

ecosio-companies-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Management Companies API
  description: API for managing companies and executing compliance and connectivity workflows on the ecosio platform.
  contact:
    name: ecosio GmbH
    url: https://ecosio.com/en
    email: support@ecosio.com
  version: 1.4.0
servers:
- url: https://api.test.ecosio-hub.com
  description: TEST instance of ecosio management.api
tags:
- name: Companies
  description: Methods for managing companies
paths:
  /api/v1/management/companies/{companyUuid}:
    get:
      tags:
      - Companies
      summary: Get a company
      operationId: getCompany
      parameters:
      - name: companyUuid
        in: path
        description: ID of the company to be retrieved. This can be the external or internal identifier.
        required: true
        schema:
          type: string
          minLength: 1
          pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyRetrievalResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - bearerAuth: []
      - basicAuth: []
      - X-APP-KEY: []
    put:
      tags:
      - Companies
      summary: Update a company
      operationId: updateCompany
      parameters:
      - name: companyUuid
        in: path
        description: External ID of the company to be updated.
        required: true
        schema:
          type: string
          minLength: 1
          pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyOperationRequest'
        required: true
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyOperationResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - bearerAuth: []
      - basicAuth: []
      - X-APP-KEY: []
  /api/v1/management/companies:
    get:
      tags:
      - Companies
      summary: Find companies
      operationId: findCompanies
      parameters:
      - name: page
        in: query
        description: Page number to be retrieved (0-indexed). The size of the page is 50
        required: false
        schema:
          type: string
          default: '0'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyRetrievalPageResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - bearerAuth: []
      - basicAuth: []
      - X-APP-KEY: []
    post:
      tags:
      - Companies
      summary: Create a company
      operationId: createCompany
      parameters:
      - name: usedForTestOnly
        in: query
        description: Marks the entity to be used only for testing purposes.
        required: false
        schema:
          type: boolean
          default: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyOperationRequest'
        required: true
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyOperationResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - bearerAuth: []
      - basicAuth: []
      - X-APP-KEY: []
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/Error'
          description: Detailed Error description
      required:
      - error
    ApprovalStatus:
      type: string
      enum:
      - PENDING
      - APPROVED
      - ERROR
      - REJECTED
      - FAILED
      - APPLIED
    CompanyAlias:
      type: object
      properties:
        name:
          type: string
          description: An alternate name or alias the company is known by. This value must be unique across all aliases.
          maxLength: 255
          minLength: 9
        description:
          type: string
          description: Description of the company alias.
          maxLength: 255
          minLength: 0
        type:
          type: string
          description: Type of the alias
          enum:
          - GLN
          - EMAIL_INBOUND_PARTICIPANT_ID
          - PEPPOL_SENDER_PARTICIPANT_ID
          - PRIMARY
    CompanyRetrievalResponse:
      type: object
      properties:
        managedCompanyUuid:
          type: string
          format: uuid
          description: The external unique identifier of the retrieved company
          example: cd13fea0-2108-11f0-836c-d3d769f7e115
        companyUuid:
          type: string
          format: uuid
          description: The internal unique identifier of the retrieved company. Can be used in the ecosio monitor or in the ecosio API.
          example: cd13fea0-2108-11f0-836c-d3d769f7e115
        companyName:
          type: string
          description: The name of the company
          example: My Company Inc.
        email:
          type: string
          format: email
          description: The email address of the company's main person of contact
          example: johndoe@example.com
        language:
          type: string
          description: The language of the company's main person of contact, in ISO 639-1 format
          example: en
        aliases:
          type: array
          description: Unique aliases to identify the company
          items:
            $ref: '#/components/schemas/CompanyAlias'
          uniqueItems: true
        parentCompanyUuid:
          type: string
          format: uuid
          description: The unique identifier of the parent company. If parent company is not yet approved, it can be the external identifier (Managed-Company-UUID), otherwise the internal identifier (Company-UUID)
          example: cd13fea0-2108-11f0-836c-d3d769f7e115
        approvalUuid:
          type: string
          format: uuid
          description: ID of this company request.
          example: cd13fea0-2108-11f0-836c-d3d769f7e115
        approvalStatus:
          $ref: '#/components/schemas/ApprovalStatus'
          description: The current status of the latest approval request.
          examples:
          - PENDING
          - APPROVED
          - REJECTED
    Error:
      type: object
      description: Describes an error item
      properties:
        code:
          type: string
          description: 'One of a server-defined set of error codes. '
          example: VALID_240
        message:
          type: string
          description: A human-readable representation of the error.
          example: Alias is not valid
        target:
          type: string
          description: The target of the error.
          example: Validation
        details:
          type: array
          description: Represent an array of related errors that occurred during the request.
          items:
            $ref: '#/components/schemas/ErrorDetail'
      required:
      - code
      - message
    ErrorDetail:
      type: object
      description: Represent a related error that occurred during the request
      properties:
        code:
          type: string
          description: 'One of a server-defined set of error codes. '
          example: VALID_110
        message:
          type: string
          description: A human-readable representation of the error.
          example: JSON is not valid
      required:
      - code
      - message
    CompanyOperationResponse:
      type: object
      properties:
        managedCompanyUuid:
          type: string
          format: uuid
          description: The external unique identifier for this company
          example: cd13fea0-2108-11f0-836c-d3d769f7e115
        approvalUuid:
          type: string
          format: uuid
          description: The unique identifier for this operation that needs to be approved
          example: cd13fea0-2108-11f0-836c-d3d769f7e115
      required:
      - approvalUuid
      - managedCompanyUuid
    CompanyRetrievalPageResponse:
      type: object
      properties:
        content:
          type: array
          description: List of items for the current page.
          items:
            $ref: '#/components/schemas/CompanyRetrievalResponse'
        totalPages:
          type: integer
          format: int32
          description: Total number of pages.
          example: 2
        totalElements:
          type: integer
          format: int64
          description: Total number of items in the entire collection.
          example: 62
        numberOfElements:
          type: integer
          format: int32
          description: Number of items for the current page.
          example: 12
        pageSize:
          type: integer
          format: int32
          description: Number of items requested per page.
          example: 50
        pageNumber:
          type: integer
          format: int32
          description: Current page number (0-indexed). The first page is 0.
          example: 1
      required:
      - content
      - numberOfElements
      - pageNumber
      - pageSize
      - totalElements
      - totalPages
    CompanyOperationRequest:
      type: object
      properties:
        companyName:
          type: string
          description: Name of the company.
          example: My Company Inc.
          maxLength: 255
          minLength: 3
        email:
          type: string
          format: email
          description: The email address of the company's main person of contact
          example: johndoe@example.com
          maxLength: 320
          minLength: 6
        language:
          type: string
          description: The language of the company's main person of contact, in ISO 639-1 format.
          example: en
        aliases:
          type: array
          description: Unique aliases to identify the company.
          items:
            $ref: '#/components/schemas/CompanyAlias'
          minItems: 1
          uniqueItems: true
        parentCompanyUuid:
          type: string
          format: uuid
          description: ID of the parent company. This can be the external or internal identifier.
          example: cd13fea0-2108-11f0-836c-d3d769f7e115
          pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
      required:
      - aliases
      - companyName
      - email
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    X-APP-KEY:
      type: apiKey
      name: X-APP-KEY
      in: header