Params

Param Name Description
organization_id
Required

Filter products by organization

Validations:

  • number.

subscription_id
Optional

Filter products by subscription

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

name
Optional

Filter products by name

Validations:

  • String

enabled
Optional

Filter products by enabled or disabled

Validations:

  • boolean

custom
Optional

Filter products by custom

Validations:

  • boolean

include_available_content
Optional

Whether to include available content attribute in results

Validations:

  • boolean

sync_plan_id
Optional

Filter products by sync plan id

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

available_for
Optional

Interpret specified object to return only Products that can be associated with specified object. Only 'sync_plan' is supported.

Validations:

  • String

search
Optional

Search string

Validations:

  • String

page
Optional

Page number, starting at 1

Validations:

  • number.

per_page
Optional

Number of results per page to return

Validations:

  • number.

order
Optional

Sort field and order, eg. 'name DESC'

Validations:

  • String

full_results
Optional

Whether or not to show all results

Validations:

  • boolean

sort
Optional

Hash version of 'order' param

Validations:

  • Hash

sort[by]
Optional

Field to sort the results on

Validations:

  • String

sort[order]
Optional

How to order the sorted results (e.g. ASC for ascending)

Validations:

  • String