Skip to main content
GET
List Products

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