Other/api.clarify.io

List bundles

v1.0.0

Gets the list of bundles. Links to each item are in the _links with link relation items.

After getting the initial list, use the first, last, next, prev link relations to get more bundles in the list. Note that next will not be available at the end of the list and prev will not be available at the start of the list. If the results are exactly one page neither prev nor next will be available.

The embed parameter specifies link relations to embed in the results. The models for the specified link relations will be in an array in the embedded object with the link relation as the key. For example, if you do embed=items, _embedded will contain a property items whose value is the array of bundle models. For link relations that are curies (ex. "clarify:metadata"), you may simply use the base name (ex. "metadata").

Input

{
  "type": "object",
  "properties": {
    "embed": {
      "type": "string"
    },
    "iterator": {
      "type": "string"
    },
    "limit": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "additionalProperties": true
}