Request Structure

How to structure your API requests to the Catalog Vendors API

This guide explains how to make requests to the Catalog Vendors API. This endpoint provides a summary of all vendors in the catalog, including their latest product update timestamps and product counts.

HTTP Method and Endpoint

All requests to the Catalog Vendors API use the GET method and should be sent to:

GET https://catalogai.vercel.app/api/vendors

Headers

Every request must include these headers:

Header	Value	Description
x-api-key	YOUR_VALID_API_KEY	Your unique API key for authentication

Unlike other Catalog API endpoints, the Vendors API doesn’t require a Content-Type header since it uses GET requests with no request body.

Request Parameters

This endpoint doesn’t accept any query parameters or request body. Simply make a GET request with your API key header.

Example Request

cURL

cURL Example

curl -X GET https://catalogai.vercel.app/api/vendors \
  -H "x-api-key: YOUR_API_KEY"

JavaScript (fetch)

JavaScript Example

const response = await fetch('https://catalogai.vercel.app/api/vendors', {
  method: 'GET',
  headers: {
    'x-api-key': 'YOUR_API_KEY'
  }
});

const data = await response.json();
console.log(data);

Python (requests)

Python Example

import requests

headers = {
    'x-api-key': 'YOUR_API_KEY'
}

response = requests.get('https://catalogai.vercel.app/api/vendors', headers=headers)
data = response.json()
print(data)

Authentication

The API requires a valid API key passed in the x-api-key header. If the API key is missing or invalid, you’ll receive a 401 Unauthorized response.

Related Guides

• Response Structure - Understanding the Vendors API response format