---
title: "Search activities"
method: POST
path: "/v1/activities/search"
tags: ["Activities"]
---

# Search activities

`POST /v1/activities/search`

Returns activities ranked by relevance to a query.

## Request body

- SearchRequest
  - `query` string, required — The search query.
  - `page` integer — Page number, starting at 1.
  - `limit` integer — Results per page.

## Response `200`

Ranked activities results.

- object
  - `data` Activity[]
    - `id` string
    - `subject` string
    - `type` string
    - `startedAt` string, date-time
    - `endedAt` string, date-time
    - `participants` Reference[]
      - `id` string
      - `type` string — The referenced resource type, e.g. "user" or "team".
    - `deals` string[]
    - `relatedResources` Reference[]
      - `id` string
      - `type` string — The referenced resource type, e.g. "user" or "team".
    - `externalReference` ExternalReference — A structured reference to a record in an external source system.
      - `source` string — The external system, e.g. a CRM provider.
      - `id` string — The record id in the external system.
    - `isPrivate` boolean
    - `createdAt` string, date-time
    - `updatedAt` string, date-time
  - `metadata` PaginationMetadata — Pagination details returned by search endpoints.
    - `page` integer
    - `limit` integer
    - `totalCount` integer
    - `totalPages` integer

## Other responses

- `401` — Missing or invalid API key credentials.

---

[API](https://skmtc.net/metal/apis/metal-api.md) · [All operations](https://skmtc.net/metal/apis/metal-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/metal/metal-api/revisions/afb7b675d5b2/schema)