Items

Get items in bulk

Returns up to 100 items by ID in one call, in the order you named them, each once. Items you can't read, trashed items and IDs that name nothing are left out.

POST
/items/bulk-get

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Header parameters

X-Marfa-Reach?string

The reach from a copy stream, for a working copy. Marfa reads the current data and checks the reach in one snapshot, and returns 409 reach_changed if it has changed. Leave it out for an ordinary read.

Match^[0-9a-f]{64}$
Length64 <= length <= 64
X-Marfa-Instance-Id?string

The ID of the instance you expect, as GET / returns it. If another instance answers at this address, Marfa returns 409 instance_changed and doesn't write. Leave it out to send the request to whichever instance answers.

Match^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Request body

application/json
  1. body
ids*array<string>

The IDs of the items to read, at most 100.

include?array<>

edges, metadata and extensions add that data to each item. system also returns system.* items, which are left out by default.

Response body

About errors

Returns the items you can read, metadata if you asked for it, and listed if you sent X-Marfa-Reach.

application/json
  1. response
data*array<>

The items you can read, in the order ids named them, each once. IDs that name nothing, a trashed item or an item whose type you can't read are left out.

metadata?array<>

The metadata of each item returned, in the same order. Present only when include has metadata.

listed?array<boolean>

For each item returned, in the same order: true if listings show you the item, false if source_filter leaves it out of them. Present only when you send X-Marfa-Reach.

  • missing_required_field: ids is missing.
  • validation_error: ids is not a list or has more than 100 IDs, or the body has a field this endpoint doesn't take.
  • invalid_id: an ID in ids is not a valid item ID.
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. If it reaches some types, items of the others are left out instead.
application/json
  1. response

An error response.

error*

What went wrong.

request_timeout: the request body didn't arrive whole within 180 seconds. Nothing changed, and Marfa closed the connection. Send the request again. A body larger than about 21 MiB can't arrive in that time over a 1 Mbit/s link, so send it in smaller requests.

application/json
  1. response

An error response.

error*

What went wrong.

reach_changed: the reach in X-Marfa-Reach has changed. Rebuild the working copy.

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.

request_too_large: the request body is larger than this instance accepts.

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 POST 'http://localhost:8600/items/bulk-get' \  -H 'Content-Type: application/json' \  -d '{  "ids": [    "string"  ]}'
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:39:50.097Z",      "last_activity_at": "2026-10-03T09:39:50.097Z",      "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": "01a1011c-2f86-76b6-9594-050c109f4957",      "type": "acme.contact",      "state": "active",      "tier": "library",      "created_at": "2026-10-03T09:38:50.592Z",      "updated_at": "2026-10-03T09:38:50.592Z",      "last_activity_at": "2026-10-03T09:38:50.592Z",      "occurred_at": "2026-10-03T09:38:50.592Z",      "source": "crm",      "source_id": "contact-17",      "version": 1,      "schema_version": 0,      "trashed_at": null,      "read_only": false,      "properties": {        "name": "Alex Example"      }    }  ],  "metadata": [    {      "item_id": "01a1011a-4902-76cf-a4a9-88e99c038c8d",      "tags": [        "renewal"      ],      "extensions": {}    },    {      "item_id": "01a1011c-2f86-76b6-9594-050c109f4957",      "tags": [],      "extensions": {}    }  ]}