List all catalogues

List all catalogues that exist in the portal

GET /catalogues

List all catalogues

cURL

curl --request GET \
  --url http://localhost:3001/portal-api/catalogues \
  --header 'Authorization: <api-key>'

import requests

url = "http://localhost:3001/portal-api/catalogues"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('http://localhost:3001/portal-api/catalogues', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3001",
  CURLOPT_URL => "http://localhost:3001/portal-api/catalogues",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <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 := "http://localhost:3001/portal-api/catalogues"

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

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("http://localhost:3001/portal-api/catalogues")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:3001/portal-api/catalogues")

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

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

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

200

[
  {
    "ID": 1,
    "Name": "Private Catalogue",
    "NameWithSlug": "private-catalogue",
    "VisibilityStatus": "Private"
  }
]

Authorizations

Authorization · string · header · required

Query Parameters

limit · integer

Maximum number of records to return for this request. Overrides the row count only, not the page offset (which is always based on per_page), so use per_page for pagination rather than combining limit with page. Defaults to the per_page value.

per_page · integer · default: 20

Items per page. Defaults to the resource-specific page count if configured, otherwise 20

page · integer · default: 1

Page number. Defaults to 1 when omitted

Response

200 - application/json

OK

ID · integer

UID of this catalogue

Example:

1

Name · string

Name of this catalogue

Example:

"Private Catalogue"

NameWithSlug · string

URL slug of this catalogue page

Example:

"private-catalogue"

VisibilityStatus · enum<string>

Visibility of this catalogue. Could be either Private or Public. The Private status means this catalogue is visible only to a limited audience while Public catalogue is available to all developers

Available options: Private, Public

Example:

"Private"