Skip to main content
GET
/
organizations
/
{orgId}
/
catalogs
List Catalogs
curl --request GET \
  --url https://api.joinrefine.io/organizations/{orgId}/catalogs \
  --header 'REFINE_API_KEY: <api-key>'
import requests

url = "https://api.joinrefine.io/organizations/{orgId}/catalogs"

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

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

print(response.text)
const options = {method: 'GET', headers: {REFINE_API_KEY: '<api-key>'}};

fetch('https://api.joinrefine.io/organizations/{orgId}/catalogs', 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.joinrefine.io/organizations/{orgId}/catalogs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"REFINE_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.joinrefine.io/organizations/{orgId}/catalogs"

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

req.Header.Add("REFINE_API_KEY", "<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("https://api.joinrefine.io/organizations/{orgId}/catalogs")
.header("REFINE_API_KEY", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.joinrefine.io/organizations/{orgId}/catalogs")

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

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

response = http.request(request)
puts response.read_body
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "productCount": 123,
    "createdAt": "2023-11-07T05:31:56Z"
  }
]
{
"status": 123,
"message": "<string>",
"time": "2023-11-07T05:31:56Z",
"method": "<string>",
"url": "<string>"
}
{
"status": 401,
"message": "Unauthorized",
"time": "2024-06-14T19:21:00Z",
"method": "GET",
"url": "/organizations/a8cd2722-1234-4567-9abc-def123456789/catalogs"
}

Authorizations

REFINE_API_KEY
string
header
required

API key for authentication

Path Parameters

orgId
string<uuid>
required

Organization ID (UUID)

Response

List of catalogs

id
string<uuid>

Catalog ID

name
string

Catalog name

description
string

Catalog description

organizationId
string<uuid>

Organization ID

productCount
integer

Number of products in catalog

createdAt
string<date-time>

Creation timestamp

status
enum<string>

Catalog processing status

Available options:
EMPTY,
PROCESSING,
WARNING,
ERROR,
PROCESSED