## List objective tools

`objectives.tools.list(objective_id, **kwargs) -> CursorPagination<ObjectiveTool>`

**get** `/v1/workspaces/{workspaceId}/objectives/{objectiveId}/tools`

Lists all tools that were assigned to an objective

### Parameters

- `workspace_id: String`

- `objective_id: String`

- `cursor: String`

  Pagination cursor from previous response

- `limit: Integer`

  Maximum number of results to return

### Returns

- `class ObjectiveTool`

  ObjectiveTool represents a tool that was assigned to an objective.

  - `metadata: BareMetadata`

    BareMetadata contains the minimal metadata for a resource: the ID and an
    optional human-readable name. These are used for reference fields where the
    full metadata (account scoping, timestamps, labels, external IDs) is not
    needed — e.g., the tool references inside an agent variation spec or the
    tools assigned to an objective. Both fields are server-populated; clients
    provide IDs through sibling fields rather than by constructing a
    BareMetadata themselves.

    - `id: String`

    - `name: String`

      Human-readable name of the referenced resource, populated by the server
      on reads for convenience. Absent on references to resources that do not
      have a name (e.g., objective tasks).

  - `snapshot: Tool`

    Snapshot of the tool at the time it was assigned to the objective. Because tools can change over time, snapshots
    are used to ensure tools don't change unexpectedly during an objective's lifecycle.

    - `metadata: ResourceMetadata`

      Standard metadata for persistent, named resources (e.g., agents, tools, prompts)

      - `id: String`

        Unique identifier for the resource (prefixed ULID, e.g., "agent_01HXK...")

      - `account_id: String`

        Account this resource belongs to for multi-tenant isolation (prefixed ULID)

      - `created_at: Time`

        Timestamp when this resource was created

      - `name: String`

        Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool")
        Required for resources that users interact with directly

      - `profile_id: String`

        ID of the actor (user or service account) that created this resource

      - `workspace_id: String`

        Workspace this resource belongs to for organizational grouping (prefixed ULID)

      - `bundle_key: String`

        Optional bundle ownership key. When set, indicates the resource is
        managed by a configuration bundle identified by this key. Used by
        BulkWorkspaceResources.Apply to track which resources belong to which
        bundle for reconciliation / soft-delete on re-apply.

      - `external_id: String`

        External ID for the resource (e.g., a workflow ID from an external system)

      - `labels: Hash[Symbol, String]`

        Arbitrary key-value pairs for categorization and filtering
        Examples: {"environment": "production", "team": "platform", "version": "v2"}

    - `spec: ToolSpec`

      - `config: ToolSpecConfig`

        Config defines the adapter to use for the tool.
        This is used to determine how the tool is called.
        For example, if the tool is an HTTP tool, the adapter will be Http.
        If the tool is an inline tool, the adapter will be Inline.

        - `http: ConfigHTTP`

          - `request_method: :HTTP_METHOD_UNSPECIFIED | :GET | :POST | 3 more`

            - `:HTTP_METHOD_UNSPECIFIED`

            - `:GET`

            - `:POST`

            - `:PUT`

            - `:PATCH`

            - `:DELETE`

          - `headers: Hash[Symbol, String]`

          - `path: String`

          - `query: String`

          - `request_body_content_type: String`

          - `request_body_template: String`

            These are only used when the request method is a POST, PUT, or PATCH

          - `tool_name: String`

            The tool name (commonly an "operation id" in OpenAPI specs) to call on the HTTP adapter. This is used to match the tool spec to the correct endpoint on the HTTP adapter.
            it will be derived from the name of the tool if not provided.

        - `mcp: ConfigMcp`

          - `tool_description: String`

          - `tool_name: String`

          - `tool_title: String`

        - `openapi: ConfigOpenAPI`

          - `method_: String`

          - `operation_id: String`

          - `path: String`

      - `description: String`

      - `parameters: Hash[Symbol, untyped]`

      - `status: :TOOL_STATUS_UNSPECIFIED | :TOOL_STATUS_AVAILABLE | :TOOL_STATUS_OMITTED | :TOOL_STATUS_ARCHIVED`

        - `:TOOL_STATUS_UNSPECIFIED`

        - `:TOOL_STATUS_AVAILABLE`

        - `:TOOL_STATUS_OMITTED`

        - `:TOOL_STATUS_ARCHIVED`

      - `requires_approval: bool`

    - `info: ToolInfo`

      - `created_by: Profile`

        A profile identifies a user or non-human principal (such as an API key)
        at the account level. Profiles are account-scoped and can be granted access
        to multiple workspaces.

        - `metadata: AccountResourceMetadata`

          AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace.

          - `id: String`

            Unique identifier for the resource (prefixed ULID, e.g., "apikey_01HXK...")

          - `account_id: String`

            Account this resource belongs to for multi-tenant isolation (prefixed ULID)

          - `name: String`

            Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool")
            Required for resources that users interact with directly

          - `profile_id: String`

          - `external_id: String`

            External ID for the resource (e.g., a workflow ID from an external system)

          - `labels: Hash[Symbol, String]`

            Arbitrary key-value pairs for categorization and filtering
            Examples: {"environment": "production", "team": "platform", "version": "v2"}

        - `spec: ProfileSpec`

          Configuration for a profile.

          - `type: :PROFILE_TYPE_UNSPECIFIED | :PROFILE_TYPE_USER | :PROFILE_TYPE_API_KEY | :PROFILE_TYPE_SYSTEM`

            Whether this profile represents a human user, an API key, or a system
            principal.

            - `:PROFILE_TYPE_UNSPECIFIED`

            - `:PROFILE_TYPE_USER`

            - `:PROFILE_TYPE_API_KEY`

            - `:PROFILE_TYPE_SYSTEM`

          - `email: String`

            Email address of the profile. Required and unique within an account for
            user profiles.

          - `name: String`

            Display name (e.g., "Bobby Tables").

      - `tool_set: ResourceMetadata`

        Standard metadata for persistent, named resources (e.g., agents, tools, prompts)

### Example

```ruby
require "cadenya"

cadenya = Cadenya::Client.new(api_key: "My API Key")

page = cadenya.objectives.tools.list("objectiveId", workspace_id: "workspaceId")

puts(page)
```

#### Response

```json
{
  "items": [
    {
      "metadata": {
        "id": "id",
        "name": "name"
      },
      "snapshot": {
        "metadata": {
          "id": "id",
          "accountId": "accountId",
          "createdAt": "2019-12-27T18:11:19.117Z",
          "name": "name",
          "profileId": "profileId",
          "workspaceId": "workspaceId",
          "bundleKey": "bundleKey",
          "externalId": "externalId",
          "labels": {
            "foo": "string"
          }
        },
        "spec": {
          "config": {
            "http": {
              "requestMethod": "HTTP_METHOD_UNSPECIFIED",
              "headers": {
                "foo": "string"
              },
              "path": "path",
              "query": "query",
              "requestBodyContentType": "requestBodyContentType",
              "requestBodyTemplate": "requestBodyTemplate",
              "toolName": "toolName"
            },
            "mcp": {
              "toolDescription": "toolDescription",
              "toolName": "toolName",
              "toolTitle": "toolTitle"
            },
            "openapi": {
              "method": "method",
              "operationId": "operationId",
              "path": "path"
            }
          },
          "description": "description",
          "parameters": {
            "foo": "bar"
          },
          "status": "TOOL_STATUS_UNSPECIFIED",
          "requiresApproval": true
        },
        "info": {
          "createdBy": {
            "metadata": {
              "id": "id",
              "accountId": "accountId",
              "name": "name",
              "profileId": "profileId",
              "externalId": "externalId",
              "labels": {
                "foo": "string"
              }
            },
            "spec": {
              "type": "PROFILE_TYPE_UNSPECIFIED",
              "email": "email",
              "name": "name"
            }
          },
          "toolSet": {
            "id": "id",
            "accountId": "accountId",
            "createdAt": "2019-12-27T18:11:19.117Z",
            "name": "name",
            "profileId": "profileId",
            "workspaceId": "workspaceId",
            "bundleKey": "bundleKey",
            "externalId": "externalId",
            "labels": {
              "foo": "string"
            }
          }
        }
      }
    }
  ],
  "pagination": {
    "nextCursor": "nextCursor",
    "total": 0
  }
}
```