INinsightly
Products

Gets a filtered list of Products

To filter with a field name and value, both field_name and field_value parameters must be provided. <br /> Simple object graphs (excluding TAGS, CUSTOMFIELDS, etc.) are returned if "brief=true" is used in the query string.

get/Product/Search

Request

  • Base URL
    https://api.insightly.com/v3.1
  • Auth
    none declared. Required headers: Authorization

Query parameters

field_namestring

Optional, field name for object

field_valuestring

Optional, field value of the record

updated_after_utcstring date-time

Optional, earliest date when a record was last updated.

briefboolean

Optional, true if response should only contain top level properties of the record.

skipinteger

Optional, number of records to skip.

topinteger

Optional, maximum number of records to return in the response.

count_totalboolean

Optional, true if total number of records should be returned in the response headers.

Headers

Authorizationstring required

Authorization

Response

Request succeeded.

PRODUCT_IDinteger
PRODUCT_NAMEstring string required
PRODUCT_CODEstring string
PRODUCT_SKUstring string
DESCRIPTIONstring string
PRODUCT_FAMILYstring string
PRODUCT_IMAGE_URLstring string
CURRENCY_CODEstring string
DEFAULT_PRICEnumber required
DATE_CREATED_UTCstring date-time
DATE_UPDATED_UTCstring date-time
CREATED_USER_IDinteger
OWNER_USER_IDinteger
ACTIVEboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.