Products
List Products
Acesso
Membro da organização com esta permissão:
products:read
Uma chave de API com scopes também precisa da permissão nos seus scopes.
GET
Lists all products with optional filtering and sorting. Filter by configured side-effect type via configuredActionType (include null for products without actions).
ApiKeyAuthheader
x-api-key<token>API key for authentication
organizationId*stringThe ID or slug of the organization
page?integerRange
-9007199254740991 <= value <= 9007199254740991limit?integerRange
-9007199254740991 <= value <= 9007199254740991sortBy?stringValue in
"id""name""description""amountPerUnit""ledger""taxPercentage""taxRegime""disabled""metadata""customFields""createdAt""updatedAt""guardCustomerLedgerBalance"sortDir?stringValue in
"asc""desc"include?|array<>|stringtaxRegime?|array<>|disabled?boolean|string|number|nullguardCustomerLedgerBalance?boolean|string|number|nullamountPerUnit?number||ledger?number||taxPercentage?number||createdAt?|nullupdatedAt?|nullname?string|array<string>|description?string|array<string>|metadata?customFields?hasItems?boolean|string|number|nullhasNoItems?boolean|string|number|nullhasConfiguredActions?boolean|string|number|nullhasNoConfiguredActions?boolean|string|number|nullhasPriceChanges?boolean|string|number|nullhasNoPriceChanges?boolean|string|number|nullhasTasks?boolean|string|number|nullhasNoTasks?boolean|string|number|nullhasEventLogs?boolean|string|number|nullhasNoEventLogs?boolean|string|number|nullhasAuditLogs?boolean|string|number|nullhasNoAuditLogs?boolean|string|number|nullitemId?string|array<string>|configuredActionId?string|array<string>|priceChangeId?string|array<string>|taskId?string|array<string>|eventLogId?string|array<string>|auditLogId?string|array<string>|search?stringconfiguredActionType?array<|unknown>meterConsumptionCustomerType?array<>meterConsumptionMeterType?array<>OK
application/json- response
curl -X GET 'https://api.tillor.eu/orgs//products'Example Response
null