Container Resource

Controls all actions concerning containers. To control the contents of those containers, see Container Item Resource.

Index

Shows a list of all containers (with their information) associated with account.

/api/containers

Method: GET
Source: Containers.index
Optional parameters:
- slug - Slug of a container. Providing this will limit the results to a single container.

Adds a new container.

/api/containers/add

Method: POST
Source: Containers.add
Required Parameters:
- name - Name of the container. The slug of the container is generated by the system.

Edits an existing container by SLUG.

/api/containers/edit/<SLUG>

Deletes a container by SLUG.

/api/containers/delete/<SLUG>

Searches all containers for items with body of provided search query.

/api/containers/search

Method: GET
Source: Containers.search
Required Parameters
- query - The search term
Optional Parameters
- page - If there is a large number of results, use this parameter to page through the results. Note: There is a page key returned with the results.