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

About errors

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.

  • validation_error: limit is out of range, cursor came from another view or an earlier version of it, or the view holds a setting that can't be listed.
  • invalid_id: the ID is invalid.
  • invalid_transition: the view is revoked.
application/json
  1. response

An error response.

error*

What went wrong.

unauthorized: the request has no credential, or its credential is not valid. For a key that has expired, details.expired_at says when it expired.

application/json
  1. response

An error response.

error*

What went wrong.

  • type_not_permitted: your credential reaches no type.
  • edge_type_not_permitted: the view's filter names an edge type, or its beneath needs parent-of, that you can't read.
application/json
  1. response

An error response.

error*

What went wrong.

  • item_not_found: no system.view you can read has this ID.
application/json
  1. response

An error response.

error*

What went wrong.

contract_mismatch: X-Marfa-Contract names another contract version than this instance speaks, or is not a whole number. Nothing was done.

application/json
  1. response

An error response.

error*

What went wrong.

rate_limited: you sent too many requests. Wait for the number of seconds in Retry-After, then try again.

application/json
  1. response

An error response.

error*

What went wrong.

internal_error: Marfa failed in a way it didn't expect, and the request may not have completed. Read what you changed before you repeat a write.

application/json
  1. response

An error response.

error*

What went wrong.

write_contention: the database was busy, and Marfa couldn't complete the request in time. Nothing changed. Try the request again. While a restore runs, details.reason is restore_running.

application/json
  1. response

An error response.

error*

What went wrong.

insufficient_storage: the disk that holds the instance's data has no room for the request, or the request would leave less free than the instance keeps in reserve. Nothing changed, unless details.write_outcome is unknown, which means the write may have landed: read what you changed before you repeat it. Free space on the disk, then try the request again.

application/json
  1. response

An error response.

error*

What went wrong.

curl -X GET 'http://localhost:8600/views/string/items'
About errors
{  "data": [    {      "id": "01a1011a-4902-76cf-a4a9-88e99c038c8d",      "type": "acme.deal",      "state": "active",      "tier": "library",      "created_at": "2026-10-03T09:37:25.975Z",      "updated_at": "2026-10-03T09:53:05.280Z",      "last_activity_at": "2026-10-03T09:53:05.280Z",      "occurred_at": "2026-10-03T09:37:25.975Z",      "source": "crm",      "source_id": "deal-1042",      "version": 2,      "schema_version": 1,      "trashed_at": null,      "read_only": false,      "properties": {        "name": "Renewal for Example Co",        "amount": 12000,        "stage": "won"      }    },    {      "id": "01a10119-55c0-77ac-9589-f7c48fa642b6",      "type": "acme.deal",      "state": "active",      "tier": "library",      "created_at": "2026-10-03T09:38:25.218Z",      "updated_at": "2026-10-03T09:53:05.280Z",      "last_activity_at": "2026-10-03T09:53:05.280Z",      "occurred_at": "2026-10-03T09:38:25.218Z",      "source": "crm",      "source_id": "deal-1043",      "version": 1,      "schema_version": 1,      "trashed_at": null,      "read_only": false,      "properties": {        "name": "Pilot for Sample Ltd",        "amount": 4500,        "stage": "won"      }    }  ],  "next_cursor": null}