Skip to main content
GET
/
organizations
/
{orgId}
/
catalogs
/
{catalogId}
/
products
List Products
curl --request GET \
  --url https://api.joinrefine.io/organizations/{orgId}/catalogs/{catalogId}/products \
  --header 'REFINE_API_KEY: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "catalogId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "imageUrl": "<string>",
      "objectUrl": "<string>",
      "descriptor": "<string>",
      "metadata": {},
      "createAt": "2023-11-07T05:31:56Z",
      "status": "PROCESSING",
      "rank": "NO_BOOST",
      "updateAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "total_items": 123,
    "total_pages": 123,
    "current_page": 123,
    "page_size": 123,
    "has_next": true,
    "has_previous": true
  }
}

Authorizations

​
REFINE_API_KEY
string
header
required

API key for authentication

Path Parameters

​
orgId
string<uuid>
required

Organization ID (UUID)

​
catalogId
string<uuid>
required

Catalog ID (UUID)

Query Parameters

​
page
integer
default:1

Page number

Required range: x >= 1
​
page_size
integer
default:25

Items per page

Required range: 1 <= x <= 100
​
search_query
string

Search in descriptor, URLs, and metadata

​
product_rank
enum<string>

Filter by product rank

Available options:
NO_BOOST,
BOOST,
SUPER_BOOST
​
status
enum<string>

Filter by product status

Available options:
PROCESSING,
PROCESSED,
ERROR
​
created_after
string<date-time>

Filter products created after this date (RFC3339)

​
created_before
string<date-time>

Filter products created before this date (RFC3339)

Response

Paginated list of products

​
data
object[]
​
pagination
object