--- title: "List products" method: GET path: "/entities/Products" tags: ["Product"] --- # List products `GET /entities/Products` ## Request - Base URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id` - URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id/entities/Products` - Auth: HTTP basic - TypeScript: (a function with typed inputs; its response is checked against the schema) Returns the products the API application can read, one page at a time. ## Query parameters - `include-deleted` boolean - `first` integer - `last` integer - `before` string - `after` string - `expand` string - `order-by` string - `filter` object - `filter-op` object - `load-only` string ## Response `200` Page of Product records. - object - `success` boolean: True when the request succeeded; false on error. - `data` Product[] - `is_delete_protected` boolean, required: True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. - `id` string, uuid, required: Unique identifier of entity. - `is_deleted` boolean: Specifies if the entity is considered deleted. - `modified` string, date-time: Last modification time. - `created` string, date-time: Creation time. - `currency_exchange_rates_list` string, uri: Currency exchange rate list used to convert monetary fields linked to this product. Empty to inherit the team space default. Related CurrencyExchangeRatesList record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'CurrencyExchangeRatesList' for its fields. - `picture` string, uri: Product picture. Related CloudObject record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'CloudObject' for its fields. - `product_category` string, uri: Product category this product belongs to. Categories form a hierarchy used in the catalog browser. Related ProductCategory record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'ProductCategory' for its fields. - `product_type` string, uri, required: Product type that classifies this product. Product types are configurable per team space and drive which form, fields and product-line behavior apply. Related ProductType record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'ProductType' for its fields. - `allowed_pipelines` 1 | 2: Whether this product can be added to all pipelines or only the explicitly linked subset (see product_pipeline_relations). Integer enum value: 1 - All, 2 - Selected - `currency_exchange_rates_list_id` string, uuid: Id of the currency exchange rate list applied to this product. - `description` string: Free-form description of the product. - `name` string, required: Name of the product, shown in catalogues and pickers. - `picture_id` string, uuid: Id of the product picture document. - `product_category_id` string, uuid: Id of the product category this product belongs to, or empty when it is not categorized. - `product_type_id` string, uuid: Id of the product type that classifies this product. - `sku` string: Stock-keeping unit (SKU) of the product, unique in the space: a second product with the same `sku` is refused with HTTP 400. - `unit_symbol` string: Unit of measure shown next to product quantities, such as pcs, kg or hours; required on create. - `revision` integer: Revision when entity was lastly changed. - `product_pipeline_relations` string[]: Deprecated pipeline connection. - `product_pipelines` object: Configuration of Pipelines where the Product can be used. - `pipelines` string[], required: Ids of the pipelines the product can be added in. Effective only when allowed_pipelines is Selected. - `allowed_pipelines` 1 | 2, required: Whether this product can be added to all pipelines or only the explicitly linked subset (see product_pipeline_relations). Integer enum value: 1 - All, 2 - Selected - `formatted_name` string, required: Display version of the product name, used in lists and references. - `oppty_product_relation_type_id` string, uuid, required: Id of the product line-item type derived from product_type. Used as a filter when listing relations on opportunities and quotes. Read-only. - `price_lists` object[]: Active price lists this product is priced in, ordered by name. Read-only; computed by Coevera. - `id` string, uuid: Id of the price list. - `name` string: Name of the price list. - `price_schedules` object[]: Active price schedules this product is priced in, ordered by name. Read-only; computed by Coevera. - `id` string, uuid: Id of the price list. - `name` string: Name of the price list. - `page_info` object: Pagination of the result; not returned when the legacy limit and offset parameters are used. - `start_cursor` string: Cursor of the first record of the page. - `end_cursor` string: Cursor of the last record of the page. - `has_previous_page` boolean: Whether records exist before this page; pass start_cursor as before to load them. - `has_next_page` boolean: Whether records exist after this page; pass end_cursor as after to load them. - `total` integer: Number of records that match the request, across all pages. ## Other responses - `400`: Bad request: a bad or unknown parameter (codes 117, 118), a missing permission (code 50), conflicting data (code 2002) or any other API error. The REST API answers 400 where others answer 403 or 409; check `code`. - `401`: Not authenticated: missing or wrong credentials, a credential of another space, or an expired token (code 401, ERROR_UNAUTHORIZED). - `429`: Too many requests (code 182). Wait for the seconds in Retry-After, then retry. - `500`: Unexpected server error (code 1000, ERROR_UNKNOWN). --- [API](https://skmtc.dev/coevera/apis/coevera-crm-api.md) - [All operations](https://skmtc.dev/coevera/apis/coevera-crm-api/llms.txt) - [OpenAPI document](https://skmtc.dev/coevera/apis/coevera-crm-api/revisions/40ebbc83f179?raw)