---
title: "List or filter all Custom Activity instances"
method: GET
path: "/activity/custom/"
tags: ["activities.custom_activities"]
---

# List or filter all Custom Activity instances

`GET /activity/custom/`

Custom Fields appear in the format: `custom.{custom_field_id}`. See [Custom Fields](https://developer.close.com/api/resources/custom-fields/custom-fields-activity).

If you're filtering by `custom_activity_type_id` or `custom_activity_type_id__in` parameter, the `lead_id` parameter will be required as well. If you want to retrieve all Custom Activity instances of a specific type regardless of the lead, you will need to get leads that contain such an activity type using [Advanced Filtering](https://developer.close.com/api/resources/advanced-filtering) and provide those Lead IDs one at a time to this endpoint.

## Query parameters

- `_limit` integer
- `_skip` integer
- `id__in` string[], nullable
- `lead_id` string[], nullable
- `contact_id` string[], nullable
- `user_id` string[], nullable
- `organization_id` string, nullable
- `_type` string[], nullable
- `date_created__gte` union
  - string, date-time
  - string, date
- `date_created__lte` union
  - string, date-time
  - string, date
- `date_created__gt` union
  - string, date-time
  - string, date
- `date_created__lt` union
  - string, date-time
  - string, date
- `activity_at__gte` union
  - string, date-time
  - string, date
- `activity_at__lte` union
  - string, date-time
  - string, date
- `activity_at__gt` union
  - string, date-time
  - string, date
- `activity_at__lt` union
  - string, date-time
  - string, date
- `custom_activity_type_id` string[], nullable
- `custom_activity_type_id__in` string
- `_fields` string

## Response `200`

Successful response

- object
  - `data` CustomActivity[], required
    - `_type` string, required
    - `activity_at` string, date-time, nullable, required
    - `comment_summary` CommentSummary
      - `comment_count` integer, required
      - `thread_id` string, required
    - `contact_id` string, nullable, required
    - `created_by` string, nullable, required
    - `created_by_name` string, nullable
    - `custom_activity_type_id` string, required
    - `date_created` string, date-time, required
    - `date_updated` string, date-time, required
    - `id` string, required
    - `last_published_at` string, date-time, nullable, required
    - `lead_id` string, nullable, required
    - `mentions` string[], required
    - `mentions_updated_at` string, date-time, nullable, required
    - `organization_id` string, required
    - `pinned` boolean, required
    - `pinned_at` string, date-time, nullable, required
    - `source` 'ui' | 'api' | 'import' | 'clipper' | 'email' | 'suggestion' | 'segment-integration' | 'customerio-integration' | 'calendly-integration' | 'ai' | 'whatsapp' | 'webform', required
    - `status` 'draft' | 'published', required
    - `updated_by` string, nullable, required
    - `updated_by_name` string, nullable
    - `user_id` string, nullable, required
    - `user_name` string, nullable
    - `users` string[], required
  - `has_more` boolean, required

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `404` — Not found

---

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