List collections

UNDER DEVELOPMENT

The following endpoint can be used to list collections for given object.

GET /:object_type/:object_id/collections

Parameters

Table of allowed parameters.

_page	unsigned int	The page of the list to display. For example, 5 will display the fifth page. Each page contains 10 resources.
_limit	unsigned int	The maximum number of resources to return. Default is 10 and maximum is 50.
_offset	unsigned int	The position in the list of resources to return from. For example, if you had 20 resources and requested an offset of 10. Resources 10 to 19 would be returned. Offset cannot be used in conjunction with `_page`.
_fields	partial string	Allows you to specify optional fields and linked objects to include in the response.

Handling the response

Below is a table of available response fields and objects that are returned within the response object of the returned object. The optional fields and objects can be requested in the _fields parameter. Underlined values are always returned.

id	Integer	A unique id assigned to the collection.
title	String	The title for the collection.
against_type	String	Name of the object the collection is against, if any. For example, issue or job.
against_id	Integer	Unique id of the object the collection is against.