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_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

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:

  • 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 Host Collections that can be associated with specified object. The value 'host' is supported.

Validations:

  • String