Skip to main content
GET
List products
Any member of the organization can list products. Narrow the list with name, skuCode, status, type and a creation date range (startDate, endDate), sort it with orderBy and order, and page through it with limit and next: each page answers the cursor of the following one as next, which is null on the last page. name matches the products whose name or SKU code contains the text, ignoring case, while skuCode and type match by contained text too. The date range is on the creation date and both ends are inclusive; a date with no time means 00:00 UTC of that day.

Path Parameters

realmId
string<uuid>
required

ID of your realm.

Format: UUID

organizationId
string<uuid>
required

ID of the organization whose products you want to list.

Format: UUID

Query Parameters

name
string

Only products whose name or SKU code contains this text (case-insensitive).

Required string length: 1 - 56
skuCode
string

Only products whose SKU code contains this text (case-insensitive).

Required string length: 1 - 50
status
enum<string>

Only products in this status.

Available options:
ACTIVE,
DEACTIVATED
type
string

Only products whose type contains this text (case-insensitive): PRODUCT or SERVICE.

Required string length: 1 - 50
startDate
string

Only products created at or after this moment, in ISO 8601. A date with no time means 00:00 UTC of that day. It can't be after endDate.

endDate
string

Only products created at or before this moment, in ISO 8601. A date with no time means 00:00 UTC of that day, so 2026-10-31 leaves out products created later on the 31st: send 2026-10-31T23:59:59.999Z to include the whole day.

limit
integer
default:15

Page size. Defaults to 15.

next
string

Cursor returned as next by the previous page. Omit it for the first page.

order
enum<string>
default:DESC

Sort direction. Defaults to DESC: newest first when sorting by createdAt.

Available options:
ASC,
DESC
orderBy
enum<string>
default:createdAt

Field to sort by. Defaults to createdAt.

Available options:
name,
value,
createdAt

Response

Successful response

A page of products.

items
object[]
required

Products, in the order you asked for (newest first by default).

next
string | null
required

Cursor for the next page. null on the last page.

Example:

"NjcxMWI0YzBkOGUxYTMwMDEyYjdjOWYy"