Supplier Connections API

1. Introduction

1.1 Overview

The HORISEN Supplier Connections API is a standard RESTful API. This document describes the API endpoints which allow exporting Supplier Connections information using either predefined templates or a custom-defined format. The endpoints provide a flexible way to retrieve Supplier Connections data tailored to different testing tools, reporting needs, or integration requirements. By selecting a specific template or defining a custom structure, users can control which Supplier Connections attributes are included and how the data is formatted, enabling seamless reuse across automated tests, quality checks, and external systems.

The subject domain is:

https://api{separator}{platform_domain}/bulk/gates/v2

Note: A domain is presented with placeholders as https://api{separator}{platform_domain}, where {separator} can be a dot (.) or a hyphen (-). Please, replace it with your actual platform domain name.

1.2 Authorization

In order to be able to call any API endpoint, you need to obtain a valid access token. Each access token has an expiration time so you need to obtain a new one if the existing one is expired.

For more information please refer to the OAuth2 Authentication Guidelines page.

1.3 Examples

This section provides practical examples demonstrating how to export Supplier Connections information using predefined templates or a custom format.

  1. The following request exports all Supplier Connections details in a TelQ template ({type}=TelQ) for the 3rd party testing tools.

    curl -L -X GET 'https://api-domain-example/bulk/gates/v2/out-gates-export/TelQ' \
-H 'Authorization: Bearer ACCESS_TOKEN'

  2. When custom type is selected (type=Custom), columns parameter is required. The following request returns Supplier Connections information, with specified columns=Id, in CSV format (format=csv). The lastChangeDt gives info about the last change for a Supplier Connections. A response example is given below.

    curl -L -X GET 'https://api-domain-example/bulk/gates/v2/out-gates-export?type=Custom&columns=Id&format=csv' \
-H 'Authorization: Bearer ACCESS_TOKEN'

    Response Example:

    [
    {
        "Id": "5292",
        "LastChangeDt": "2026-01-09T09:50:48Z"
    },
    {
        "Id": "5293",
        "LastChangeDt": "2026-01-09T09:57:08Z"
    },
    {
        "Id": "5295",
        "LastChangeDt": "2026-01-09T13:38:30Z"
    }
]

  3. The following API call returns all standard Supplier Connections information with type=Custom, with all available columns (allColumns=YES), in JSON format (format=json).

    curl -L -X GET 'https://api-domain-example/bulk/gates/v2/out-gates-export?type=Custom&allColumns=YES&format=json' \
-H 'Authorization: Bearer ACCESS_TOKEN'

2. Methods Overview

The following endpoints are Supplier Connections related, and can be used for exporting Supplier Connections information in predefined or custom formats.

GET/out-gates-export/{type}
Downloads export file in specified format.Read More
GET/out-gates-export
Downloads export file in specified format.Read More

3. Methods Details

The following endpoints are Supplier Connections related, and can be used for exporting Supplier Connections information in predefined or custom formats. Find below the endpoints descriptions and details.

GET/out-gates-export/{type}
Downloads export file in specified format.Up
Method Overview

The method downloads export file in specified format.

When type is "Custom", columns parameter is required.

Authorization privilege needed for this endpoint:
- bulk-gates.view - Logged user can see data in export file for all gateways.
- bulk-gates-own.view - Logged user can see data in export file only for his own gateways.
- bulk-settings-supplier-sms.complete - Logged user can see data in export file for all gateways, including password.

URL Parameters
Name Type Description
type (required) string (path) File type.
Available values: iTest, ARPTel, TelQ, Custom.
format string (query) Export file format. Default is xlsx.
Available values : csv, json, xlsx. Default value is xlsx.
columns string (query) Comma-separated list of column names to export. Required when type is "Custom".
Allowed columns: Id, GroupId, Name, Cname, SupplierId, PriceListId, Status, StatusDt, ConnIndex, BillingAccountId, OverVpn, VpnConnId, InsertDt, SetupDate, PriceListName, PriceListStatus, PackageName, PackageStatus, ClientId, ClientName, ClientNameBrief, OwnerId, OwnerName, OwnerNameBrief, OwnerBpId, OwnerBpName, OwnerBpBriefName, GroupName.
allColumns string (query) Whether to export all columns. Available values : YES, NO. Default value: NO.
all string (query) Return all data for given criteria. Available values : yes, no. Default value: no.
page_size integer (query) Page size. Default value is 10.
page_number integer (query) Page number. Default value is 1.
paging string (query) Paging options. The format is: &paging=page_num,page_size. E.g. paging=1,10.
sort string (query) Sorting options. The format is: sort=-attribute1,attribute2,-attribute3.
operator(fieldName) string (query) Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includelds, and the following attributes: id, name, cname, status, statusDt, supplierId, priceListId, billingAccountId, clientName, clientNameBrief, ownerName, ownerNameBrief, insertDt, setupDate, groupId, groupName, overVpn, vpnConnId, ownerBpId, ownerBpName, ownerBpBriefName.

  • If the operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted.
  • If the operator is in or notin, a field value must be a comma separated list of values.
  • If the operator is between or notbetween, a field value must be a comma separated list of two values representing the beginning and the end of a range.
  • Sort operator using following operators: id, name, cname, status, statusDt, supplierId, priceListId, billingAccountId, clientName, clientNameBrief, ownerName, ownerNameBrief, insertDt, setupDate, groupId, groupName, overVpn, vpnConnId, ownerBpId, ownerBpName, ownerBpBriefName.
  • Operator can be omitted and in that case it will be treated as operator is 'eq' (E.g.: fieldName=fieldValue).
  • Example: startswith(clientName)=hor, starts with 'hor' in field clientName.
  • If fieldName is 'q' and operator is eq or omitted, a field value will be used in general search across multiple attributes.
q string (query) Search criteria.
Supported Response Format
Name Description
text/csv The response is a CSV file.
application/json The response is in JSON format.
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet Indicates that the response is an Excel file.
Responses
Code Description Links
200 Export file (CSV, JSON, or XLSX depending on format parameter). No links.
default Unexpected Error. No links.
Error Response Unexpected Error: Default
{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
GET/out-gates-export
Download export file.Up
Method Overview

The method downloads export file in specified format.

When type is "Custom", columns parameter is required.

Authorization privilege needed for this endpoint:
- bulk-gates.view - Logged user can see data in export file for all gateways.
- bulk-gates-own.view - Logged user can see data in export file only for his own gateways.
- bulk-settings-supplier-sms.complete - Logged user can see data in export file for all gateways, including password.

URL Parameters
Name Type Description
type (required) string (query) File type.
Available values: iTest, ARPTel, TelQ, Custom.
format string (query) Export file format. Default is xlsx.
Available values : csv, json, xlsx. Default value is xlsx.
columns string (query) Comma-separated list of column names to export. Required when type is "Custom".
Allowed columns: Id, GroupId, Name, Cname, SupplierId, PriceListId, Status, StatusDt, ConnIndex, BillingAccountId, OverVpn, VpnConnId, InsertDt, SetupDate, PriceListName, PriceListStatus, PackageName, PackageStatus, ClientId, ClientName, ClientNameBrief, OwnerId, OwnerName, OwnerNameBrief, OwnerBpId, OwnerBpName, OwnerBpBriefName, GroupName.
allColumns string (query) Whether to export all columns. Available values : YES, NO. Default value: NO.
all string (query) Return all data for given criteria. Available values : yes, no. Default value: no.
page_size integer (query) Page size. Default value is 10.
page_number integer (query) Page number. Default value is 1.
paging string (query) Paging options. The format is: &paging=page_num,page_size. E.g. paging=1,10.
sort string (query) Sorting options. The format is: sort=-attribute1,attribute2,-attribute3.
operator(fieldName) string (query) Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includelds, and the following attributes: id, name, cname, status, statusDt, supplierId, priceListId, billingAccountId, clientName, clientNameBrief, ownerName, ownerNameBrief, insertDt, setupDate, groupId, groupName, overVpn, vpnConnId, ownerBpId, ownerBpName, ownerBpBriefName.

  • If the operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted.
  • If the operator is in or notin, a field value must be a comma separated list of values.
  • If the operator is between or notbetween, a field value must be a comma separated list of two values representing the beginning and the end of a range.
  • Sort operator using following operators: id, name, cname, status, statusDt, supplierId, priceListId, billingAccountId, clientName, clientNameBrief, ownerName, ownerNameBrief, insertDt, setupDate, groupId, groupName, overVpn, vpnConnId, ownerBpId, ownerBpName, ownerBpBriefName.
  • Operator can be omitted and in that case it will be treated as operator is 'eq' (E.g.: fieldName=fieldValue).
  • Example: startswith(clientName)=hor, starts with 'hor' in field clientName.
  • If fieldName is 'q' and operator is eq or omitted, a field value will be used in general search across multiple attributes.
q string (query) Search criteria.
Supported Response Format
Name Description
text/csv The response is a CSV file.
application/json The response is in JSON format.
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet Indicates that the response is an Excel file.
Responses
Code Description Links
200 Export file (CSV, JSON, or XLSX depending on format parameter). No links.
default Unexpected Error. No links.
Error Response Unexpected Error: Default
{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}