Einblick Docs

Relation fields (relation / relations) contain lightweight references:

{ "id": "bld_12", "slug": "town-hall", "collection": "buildings" }

To avoid extra round-trips, ask the API to deliver the referenced records in the same response with the include parameter.

Basic usage

curl "https://actions.einblick.xyz/api/v1/events?include=building" \
  -H "Authorization: Bearer api_YOUR_KEY"

Included records are returned in a top-level included array, in the same { type, id, attributes, meta } shape as data:

{
  "data": [
    {
      "type": "events",
      "id": "evt_1",
      "attributes": {
        "title": "Open House 2026",
        "building": {
          "id": "bld_12",
          "slug": "town-hall",
          "collection": "buildings"
        }
      },
      "meta": { "createdAt": 1767222000000 }
    }
  ],
  "included": [
    {
      "type": "buildings",
      "id": "bld_12",
      "attributes": { "name": "Town Hall" },
      "meta": { "slug": "town-hall", "createdAt": 1767222000000 }
    }
  ]
}

Match references to included records by id (and collection / type).

Multiple and nested includes

Combine several relations with commas, and use dotted paths to expand relations of included records:

curl "https://actions.einblick.xyz/api/v1/events?include=building,organizer.contact" \
  -H "Authorization: Bearer api_YOUR_KEY"

Which fields are expandable is listed in meta.fields (expandable: true) and in the key-scoped OpenAPI schema. Your key needs read access to the target resource for records to be included — references to resources the key cannot read stay as plain references.

Invalid include paths are rejected with 400 Bad Request.