Items

Find items by title

Finds the active and archived items titled by each of up to 200 names, matched without regard to case, Unicode form or the white space around a name. system.* items and items you can't read are left out.

POST
/items/titles

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Header parameters

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
names*array<>

The titles to look for, at most 200, each at most 1000 UTF-16 code units. Case, Unicode form and surrounding white space do not matter.

Itemsitems <= 200

Response body

Returns one result for each name. A name matching nothing, or empty after trimming, has no items.

application/json
  1. response
results*array<>

One result for each name, in the order the request named them.

curl -X POST 'http://localhost:8600/items/titles' \  -H 'Content-Type: application/json' \  -d '{  "names": [    "string"  ]}'
{  "results": [    {      "name": "string",      "items": [        {          "id": "string",          "type": "string",          "title": "string",          "has_blob": true        }      ],      "more": true    }  ]}