MetorialDocs

Store Items

Inspect items within an instance store.

The Store Item object

store_item.json
{
  "object": "store.item",
  "id": "example_id",
  "kind": "file",
  "path": "example_path",
  "store_id": "example_store_id",
  "directory_id": "example_directory_id",
  "file": {
    "object": "file",
    "id": "fil_9jKlMnPqRsTuVwXy",
    "status": "active",
    "file_name": "company-logo.png",
    "file_size": 245760,
    "file_type": "image/png",
    "title": "Company Logo",
    "purpose": "organization_logo",
    "created_by": {
      "type": "organization_actor",
      "name": "example_name",
      "image_url": "example_image_url",
      "email": "example_email",
      "organization_actor": {
        "object": "organization.actor",
        "id": "omem_5fGhJkLmNpQrStUv",
        "type": "member",
        "organization_id": "org_7hNkPqRsTuVwXyZa",
        "name": "Alex Chen",
        "email": "[email protected]",
        "image_url": "https://avatar-cdn.metorial.com/aimg_1234567890",
        "member": {
          "object": "organization.member#preview",
          "id": "ome_7hNkPqRsTuVwXyZa",
          "status": "active",
          "role": "member"
        },
        "teams": [
          {
            "id": "tm_3eFgHjKlMnPqRsTu",
            "name": "Engineering",
            "slug": "engineering",
            "assignment_id": "tmas_8jKlMnPqRsTuVwXy"
          },
          {
            "id": "tm_3eFgHjKlMnPqRsTu",
            "name": "Engineering",
            "slug": "engineering",
            "assignment_id": "tmas_8jKlMnPqRsTuVwXy"
          }
        ],
        "created_at": "2026-10-17T09:50:02.659Z",
        "updated_at": "2026-10-17T09:50:02.659Z"
      },
      "consumer": {
        "object": "consumer",
        "id": "example_id",
        "name": "example_name",
        "email": "example_email",
        "image_url": "example_image_url",
        "user_id": "example_user_id",
        "created_at": "2026-10-17T09:50:02.659Z",
        "updated_at": "2026-10-17T09:50:02.659Z"
      },
      "consumer_profile": {
        "object": "consumer.profile",
        "id": "example_id",
        "name": "example_name",
        "email": "example_email",
        "image_url": "example_image_url",
        "consumer_id": "example_consumer_id",
        "user_id": "example_user_id",
        "status": "active",
        "created_at": "2026-10-17T09:50:02.659Z",
        "updated_at": "2026-10-17T09:50:02.659Z",
        "groups": [
          {
            "object": "consumer.profile.group_assignment",
            "group": {
              "object": "consumer.group",
              "id": "example_id",
              "status": "active",
              "name": "example_name",
              "description": "example_description",
              "is_default": false,
              "created_at": "2026-10-17T09:50:02.659Z",
              "updated_at": "2026-10-17T09:50:02.659Z"
            },
            "assigned_via": "default"
          }
        ]
      }
    },
    "created_at": "2026-10-17T09:50:02.659Z",
    "updated_at": "2026-10-17T09:50:02.659Z"
  },
  "document": {
    "object": "document",
    "id": "example_id",
    "status": "active",
    "title": "example_title",
    "content": "example_content",
    "file_id": "example_file_id",
    "parent_document_id": "example_parent_document_id",
    "current_version_id": "example_current_version_id",
    "created_by": {
      "type": "organization_actor",
      "name": "example_name",
      "image_url": "example_image_url",
      "email": "example_email",
      "organization_actor": {
        "object": "organization.actor",
        "id": "omem_5fGhJkLmNpQrStUv",
        "type": "member",
        "organization_id": "org_7hNkPqRsTuVwXyZa",
        "name": "Alex Chen",
        "email": "[email protected]",
        "image_url": "https://avatar-cdn.metorial.com/aimg_1234567890",
        "member": {
          "object": "organization.member#preview",
          "id": "ome_7hNkPqRsTuVwXyZa",
          "status": "active",
          "role": "member"
        },
        "teams": [
          {
            "id": "tm_3eFgHjKlMnPqRsTu",
            "name": "Engineering",
            "slug": "engineering",
            "assignment_id": "tmas_8jKlMnPqRsTuVwXy"
          },
          {
            "id": "tm_3eFgHjKlMnPqRsTu",
            "name": "Engineering",
            "slug": "engineering",
            "assignment_id": "tmas_8jKlMnPqRsTuVwXy"
          }
        ],
        "created_at": "2026-10-17T09:50:02.659Z",
        "updated_at": "2026-10-17T09:50:02.659Z"
      },
      "consumer": {
        "object": "consumer",
        "id": "example_id",
        "name": "example_name",
        "email": "example_email",
        "image_url": "example_image_url",
        "user_id": "example_user_id",
        "created_at": "2026-10-17T09:50:02.659Z",
        "updated_at": "2026-10-17T09:50:02.659Z"
      },
      "consumer_profile": {
        "object": "consumer.profile",
        "id": "example_id",
        "name": "example_name",
        "email": "example_email",
        "image_url": "example_image_url",
        "consumer_id": "example_consumer_id",
        "user_id": "example_user_id",
        "status": "active",
        "created_at": "2026-10-17T09:50:02.659Z",
        "updated_at": "2026-10-17T09:50:02.659Z",
        "groups": [
          {
            "object": "consumer.profile.group_assignment",
            "group": {
              "object": "consumer.group",
              "id": "example_id",
              "status": "active",
              "name": "example_name",
              "description": "example_description",
              "is_default": false,
              "created_at": "2026-10-17T09:50:02.659Z",
              "updated_at": "2026-10-17T09:50:02.659Z"
            },
            "assigned_via": "default"
          }
        ]
      }
    },
    "created_at": "2026-10-17T09:50:02.659Z",
    "updated_at": "2026-10-17T09:50:02.659Z"
  },
  "created_at": "2026-10-17T09:50:02.659Z",
  "updated_at": "2026-10-17T09:50:02.659Z"
}
object"store.item"required
idstringrequired
kind"file" | "document" | "directory"required
pathstringrequired
store_idstringrequired
directory_idstringrequirednullable
created_atdaterequired
updated_atdaterequired

Endpoints

List store items

GET/stores/:store_id/items

Returns a paginated list of items for a specific store.

Path parameters

store_idstringrequired

The unique identifier for the store

Query parameters

idstring or string[]optional

Filter by store item ID

file_idstring or string[]optional

Filter by file ID

document_idstring or string[]optional

Filter by document ID

type"file" | "document" | "directory" or "file" | "document" | "directory"[]optional

Filter by store item type. Repeat `type` to include multiple values. Defaults to `file` and `document`.

Example request

curl -X GET "https://api.metorial.com/stores/sto_Rm4Mnheq2bfEPhBhP7SY/items" \
  -H "Authorization: Bearer metorial_sk_io2h4..."

Get store item by ID

GET/stores/:store_id/items/:item_id

Retrieves a specific item within a store.

Path parameters

store_idstringrequired

The unique identifier for the store

item_idstringrequired

The unique identifier for the item

Example request

curl -X GET "https://api.metorial.com/stores/sto_Rm4Mnheq2bfEPhBhP7SY/items/ite_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_io2h4..."