Get an overview
Returns what the instance holds that your credential can reach: types with item counts, edge types, top tags, views and folders, and what your credential may do. Every list is capped. Needs no type access.
bearerAuthAuthorizationBearer <token>Authenticate with an API key (marfa_k1_…) or an OAuth access token (marfa_at_…).
Returns the overview. A credential that reaches nothing gets the instance and credential only.
application/json- response
A summary of what this instance holds and what your credential may reach.
instance*The instance's name and the build it runs.
credential*The credential that sent the request, and what it may do.
types?array<>The types you can read, most items first, then by identifier, at most 50. Types in the system namespace are left out. Absent when you can read none.
total?integerHow many active items you can read across every type types would list before its cut. Absent when types is.
edge_types?array<>The edge types you can read or write, sorted by identifier, at most 50. Absent when you can read no type or can use no edge type.
tags?array<>The most used tags on items you can read, at most 30. Absent when there are none.
views?array<>The views you can read, sorted by title, at most 30. Absent when there are none.
folders?array<>The folders you can read, sorted by title, at most 30. Absent when there are none.
truncated?Each list that was cut, with how many entries it held before the cut. Names are types, edge_types, tags, views, folders and credential.type_permissions.<level>. Absent when nothing was cut.
curl -X GET 'http://localhost:8600/overview'{ "instance": { "name": "string", "version": "string", "release": "string" }, "credential": { "kind": "key", "label": "string", "type_permissions": { "write": [ "string" ], "read": [ "string" ], "none": [ "string" ] }, "permissions": [ "webhooks.manage" ] }, "types": [ { "id": "string", "description": "string", "count": 0 } ], "total": 0, "edge_types": [ { "id": "string", "description": "string", "access": "read" } ], "tags": [ { "tag": "string", "count": 0 } ], "views": [ { "id": "string", "title": "string" } ], "folders": [ { "id": "string", "title": "string" } ], "truncated": { "property1": 0, "property2": 0 }}