🔒 List products V3

get

https://{xentralId}.xentral.biz/api/v3/products

This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues.

This endpoint requires the following scopes: product:read.

Paginated list of products. Embed sub-resources with ?include=.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

filter

array of objects

The filter parameter is used to filter the results of the given endpoint.

Supported filter operators by key:

id: equals, notEquals, in, notIn

number: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

ean: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

name: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

project.id: equals, notEquals, in, notIn

isVariant: equals, notEquals

isMatrixProduct: equals, notEquals

updatedAt: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals, isNull, isNotNull

isDisabled: equals, notEquals

isDeleted: equals, notEquals

filter

sort

array

Sort via id, -id, number, -number, name, -name, updatedAt and -updatedAt. Default sort is -id

sort

include

array of strings

include

perPage

integer

Number of items per page. Default: 15, Max: 5000

page

integer

Page number. Only used with simple and table pagination.

cursor

string

The cursor to use for the paginated call. Only used with cursor pagination. Not compatible with page parameter

Headers

x-pagination

string

enum

Controls the pagination format. Available types: simple, table, cursor. Defaults to 'simple' if not specified.

Allowed:

Responses

401

Unauthorized

403

Forbidden

200Paginated list of products. Embed sub-resources with ?include=.

429Too Many Requests