Get all portfolios - Inyett API

GET

{profileCountry}

monitor

portfolios

Get all portfolios

curl --request GET \
  --url https://api.example.com/3/{profileCountry}/monitor/portfolios \
  --header 'X-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://api.example.com/3/{profileCountry}/monitor/portfolios', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/3/{profileCountry}/monitor/portfolios",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/3/{profileCountry}/monitor/portfolios"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/3/{profileCountry}/monitor/portfolios")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": 1,
      "type": "Auto",
      "name": "Foo",
      "createdDate": "2024-01-01T00:00:00",
      "updatedDate": "2024-01-01T00:00:00",
      "enabled": true
    },
    {
      "id": 2,
      "type": "Manual",
      "name": "Bar",
      "createdDate": "2024-01-01T00:00:00",
      "updatedDate": "2024-01-01T00:00:00",
      "enabled": false
    }
  ],
  "total": 2
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "errors": {}
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Authorizations

X-Api-Key

string

header

required

Api key needed to access the endpoints. X-Api-Key: My api key

Headers

AppId

string

App id

Path Parameters

profileCountry

enum<string>

required

The country whose scope/entitlement profile (SE or NO) is used to authorize the request. Determines which market-specific rules apply, independent of the country the requested company is registered in. ISO country code supported for company lookups: SE (Sweden) or NO (Norway).

Available options:

SE,

NO

Query Parameters

Fetch

integer<int32>

Required if Offset is set

Offset

integer<int32>

Required if Fetch is set

portfolioType

enum<string>

Filters portfolios by how their companies are managed: Manual (added individually) or Auto (kept in sync automatically). How companies are added to a portfolio: Manual (added individually) or Auto (kept in sync automatically).

Available options:

Manual,

Auto

Response

A page of monitoring portfolios, together with the total number of matching portfolios.

data

object[] | null

Show child attributes

total

integer<int32>

⌘I

Get all portfolios

curl --request GET \
  --url https://api.example.com/3/{profileCountry}/monitor/portfolios \
  --header 'X-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://api.example.com/3/{profileCountry}/monitor/portfolios', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/3/{profileCountry}/monitor/portfolios",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/3/{profileCountry}/monitor/portfolios"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/3/{profileCountry}/monitor/portfolios")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": 1,
      "type": "Auto",
      "name": "Foo",
      "createdDate": "2024-01-01T00:00:00",
      "updatedDate": "2024-01-01T00:00:00",
      "enabled": true
    },
    {
      "id": 2,
      "type": "Manual",
      "name": "Bar",
      "createdDate": "2024-01-01T00:00:00",
      "updatedDate": "2024-01-01T00:00:00",
      "enabled": false
    }
  ],
  "total": 2
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "errors": {}
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}