Skip to main content
POST
/
organizations
/
{orgId}
/
catalogs
Create Catalog
curl --request POST \
  --url https://api.joinrefine.io/organizations/{orgId}/catalogs \
  --header 'Content-Type: application/json' \
  --header 'REFINE_API_KEY: <api-key>' \
  --data '
{
  "name": "Summer 2024",
  "organizationId": "a8cd2722-1234-4567-9abc-def123456789",
  "description": "New arrivals for summer."
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "productCount": 123,
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
REFINE_API_KEY
string
header
required

API key for authentication

Path Parameters

​
orgId
string<uuid>
required

Organization ID (UUID)

Example:

"a8cd2722-1234-4567-9abc-def123456789"

Body

application/json
​
name
string
required

Catalog name (must be unique within organization)

Example:

"Summer 2024"

​
organizationId
string<uuid>
required

Organization ID (must match path parameter)

Example:

"a8cd2722-1234-4567-9abc-def123456789"

​
description
string

Catalog description

Example:

"New arrivals for summer."

Response

Catalog created successfully

​
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