GET /api/bookmarks
List all bookmarks

Examples

GET /api/v2/bookmarks?page=1&per_page=10&search=
200
{
  "total": 2,
  "subtotal": 2,
  "page": 1,
  "per_page": 10,
  "search": "",
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "name": "foo",
      "controller": "hosts",
      "query": "foo=boo",
      "public": true,
      "id": 980190962,
      "owner_id": null,
      "owner_type": null
    },
    {
      "name": "three",
      "controller": "hosts",
      "query": "three",
      "public": true,
      "id": 113629430,
      "owner_id": null,
      "owner_type": null
    }
  ]
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
search
optional

filter results

Validations:

  • Must be a String
order
optional

Sort and order by a searchable field, e.g. '<field> DESC'

Validations:

  • Must be a String
page
optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
optional

Number of results per page to return, 'all' to return all results

Validations:

  • Must match regular expression /\A([1-9]\d*|all)\Z$/.

Search fields

Field name Type Possible values
controller string
id integer
name string