Views

List a view's items

Returns a page of the items a view lists, in the view's sort order. Items of types you can't read are left out. A view's grouping isn't applied.

GET
/views/{id}/items

Authorization

bearerAuth
headerAuthorizationBearer <token>

Authenticate with an API key (marfa_k1_…) or an OAuth access token (marfa_at_…).

Path parameters

id*string

The ID of the view.

Query parameters

limit?integer

The maximum number of results to return.

Range1 <= value <= 200
Default50
cursor?string

The next_cursor from the previous page. Leave it out to get the first page.

Response body

Returns a page of items.

application/json
  1. response

A page of the items a view lists.

data*array<>

The items on this page, in the view's sort order.

next_cursor*|

Pass as cursor for the next page; null on the last. A page can be short, or empty, with a cursor still to follow, so a walk stops on null and never on a short page.

curl -X GET 'http://localhost:8600/views/string/items'
{  "data": [    {      "id": "string",      "type": "string",      "properties": {        "property1": null,        "property2": null      },      "state": "active",      "tier": "library",      "version": 1,      "schema_version": 0,      "source": "string",      "source_id": "string",      "read_only": true,      "capture_latitude": 0,      "capture_longitude": 0,      "occurred_at": "string",      "created_at": "string",      "updated_at": "string",      "trashed_at": "string",      "trashed_by_cascade": true,      "trashed_with": "string",      "edges": {        "property1": {          "data": [            {              "id": "string",              "source_id": "string",              "target_id": "string",              "edge_type": "string",              "properties": {                "property1": null,                "property2": null              },              "created_at": "string",              "updated_at": "string",              "version": 1            }          ],          "next_cursor": "string"        },        "property2": {          "data": [            {              "id": "string",              "source_id": "string",              "target_id": "string",              "edge_type": "string",              "properties": {                "property1": null,                "property2": null              },              "created_at": "string",              "updated_at": "string",              "version": 1            }          ],          "next_cursor": "string"        }      },      "extensions": {        "property1": {          "property1": null,          "property2": null        },        "property2": {          "property1": null,          "property2": null        }      }    }  ],  "next_cursor": "string"}