Params

Param name Description
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_result
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

organization_id
optional

organization identifier

Validations:

  • number.

name
optional

host collection name to filter by

Validations:

  • String

activation_key_id
optional

activation key identifier

Validations:

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

host_id
optional

Filter products by host id

Validations:

  • number.

available_for
optional

Interpret specified object to return only Host Collections that can be associated with specified object. The value ‘host’ is supported.

Validations:

  • String