---
title: "Get Run Metadata"
method: GET
path: "/api/v1/run-metadata/{run_metadata_id}"
tags: ["run_metadata"]
---

# Get Run Metadata

`GET /api/v1/run-metadata/{run_metadata_id}`

Get run metadata by ID.

Args:
    run_metadata_id: The ID of run metadata.
    hydrate: Flag deciding whether to hydrate the output model(s)
        by including metadata fields in the response.

Returns:
    The run metadata response.

## Path parameters

- `run_metadata_id` string, uuid, required

## Query parameters

- `hydrate` boolean

## Response `200`

Successful Response

- RunMetadataResponse — Response model for run metadata.
  - `body` RunMetadataResponseBody — Response body for run metadata.
    - `created` string, date-time, required
    - `updated` string, date-time, required
    - `user` UserResponse — Response model for user and service accounts. This returns the activation_token that is required for the user-invitation-flow of the frontend. The email is returned optionally as well for use by the analytics on the client-side.
      - `body` UserResponseBody — Response body for users.
        - `created` string, date-time, required
        - `updated` string, date-time, required
        - `active` boolean
        - `activation_token` string, nullable
        - `full_name` string
        - `email_opted_in` boolean, nullable — `null` if not answered, `true` if agreed, `false` if skipped.
        - `is_service_account` boolean, required
        - `is_admin` boolean, required
      - `metadata` UserResponseMetadata — Response metadata for users.
        - `email` string, nullable
        - `external_user_id` string, uuid, nullable
        - `user_metadata` object
      - `resources` UserResponseResources — Class for all resource models associated with the user entity.
      - `id` string, uuid, required
      - `permission_denied` boolean
      - `name` string, required
    - `key` string, required
    - `value` union, required
      - string
      - integer
      - number
      - boolean
      - object
      - unknown[]
        - unknown
      - unknown[]
        - unknown
    - `type` 'str' | 'int' | 'float' | 'bool' | 'list' | 'dict' | 'tuple' | 'set' | 'Uri' | 'Path' | 'DType' | 'StorageSize', required — String Enum of all possible types that metadata can have.
  - `metadata` RunMetadataResponseMetadata — Response metadata for run metadata.
    - `workspace` WorkspaceResponse, required — Response model for workspaces.
      - `body` WorkspaceResponseBody — Response body for workspaces.
        - `created` string, date-time, required
        - `updated` string, date-time, required
      - `metadata` WorkspaceResponseMetadata — Response metadata for workspaces.
        - `description` string
      - `resources` WorkspaceResponseResources — Class for all resource models associated with the workspace entity.
      - `id` string, uuid, required
      - `permission_denied` boolean
      - `name` string, required
    - `resource_id` string, uuid, required
    - `resource_type` 'pipeline_run' | 'step_run' | 'artifact_version' | 'model_version', required — All possible resource types for adding metadata.
    - `stack_component_id` string, uuid, nullable, required
  - `resources` RunMetadataResponseResources — Class for all resource models associated with the run metadata entity.
  - `id` string, uuid, required
  - `permission_denied` boolean

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `422` — Unprocessable Entity

---

[API](https://skmtc.net/zenml-io/apis/zenml-2.md) · [All operations](https://skmtc.net/zenml-io/apis/zenml-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/zenml-io/zenml-2/versions/febb01b8bce3/schema)