Fetch products

deprecated

This endpoint has been deprecated and may be removed in future versions of the API.

**Use: ** /products?providerId=[id]

Returns products filtered by query parameters from provider identified by providerId. The result will contain public and private products for which the caller is authorized to read.

Path Parameters
providerId uuid — REQUIRED The organization id providing the products

Query Parameters
private boolean Whether to include private products, true if omitted.
public boolean Whether to include public products, true if omitted.

Header Parameters
organization-id uuid — REQUIRED ID of organization context this request belongs to.

Responses
200 List of products Schema — OPTIONAL products object[] — OPTIONAL accessDefinitionId uuid — OPTIONAL colour string — OPTIONAL createdAt date-time — OPTIONAL createdBy uuid — OPTIONAL description string — OPTIONAL detailedDescription string — OPTIONAL id uuid — OPTIONAL name string — OPTIONAL organization object — OPTIONAL createdAt date-time — OPTIONAL deletedAt date-time — OPTIONAL email string — OPTIONAL id uuid — OPTIONAL logo string — OPTIONAL name string — OPTIONAL provider boolean — OPTIONAL active boolean — OPTIONAL organizationId uuid — OPTIONAL Use: organization.id organizationName string — OPTIONAL Use: organization.name plans object[] — OPTIONAL createdAt date-time — OPTIONAL createdBy uuid — OPTIONAL deleted boolean — OPTIONAL description string — OPTIONAL id uuid — OPTIONAL name string — OPTIONAL planType string — OPTIONAL Possible values: [STATIC, DYNAMIC] productId uuid — OPTIONAL updatedAt date-time — OPTIONAL updatedBy uuid — OPTIONAL validity object — OPTIONAL validFrom date-time — OPTIONAL validUntil date-time — OPTIONAL version string — OPTIONAL productLinks object[] — OPTIONAL id uuid — OPTIONAL name string — OPTIONAL orderNum int32 — OPTIONAL url string — OPTIONAL productStatus string — OPTIONAL Possible values: [DRAFT, PUBLISHED] publiclyAvailable boolean — OPTIONAL supportMultiplePlans boolean — OPTIONAL
400 Bad Request (e.g. element not found or resource conflict). Schema — OPTIONAL message string — OPTIONAL timestamp date-time — OPTIONAL traceId string — OPTIONAL type string — OPTIONAL
403 Missing permission Schema — OPTIONAL message string — OPTIONAL timestamp date-time — OPTIONAL traceId string — OPTIONAL type string — OPTIONAL
500 Internal server error (Internal service communication or process error). Schema — OPTIONAL message string — OPTIONAL timestamp date-time — OPTIONAL traceId string — OPTIONAL type string — OPTIONAL