# List or filter all Custom Activity instances

GET https://api.close.com/api/v1/activity/custom/

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

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](/resources/advanced-filtering/) and provide those Lead IDs one at a time to this endpoint.

Reference: https://developer.close.com/api/resources/activities/custom-activities/list

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: Close API
  version: 1.0.0
paths:
  /activity/custom/:
    get:
      operationId: list
      summary: List or filter all Custom Activity instances
      description: >-
        Custom Fields appear in the format: `custom.{custom_field_id}`. See
        [Custom Fields](/resources/custom-fields/activity-custom-fields/).


        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](/resources/advanced-filtering/) and provide those Lead IDs
        one at a time to this endpoint.
      tags:
        - subpackage_activitiesCustomActivities
      parameters:
        - name: _limit
          in: query
          description: Number of results to return.
          required: false
          schema:
            type: integer
            default: 100
        - name: _skip
          in: query
          description: Number of results to skip before returning, for pagination.
          required: false
          schema:
            type: integer
            default: 0
        - name: id__in
          in: query
          description: Filter by activity IDs (comma-separated)
          required: false
          schema:
            type:
              - array
              - 'null'
            items:
              type: string
        - name: lead_id
          in: query
          description: Filter by lead IDs (comma-separated)
          required: false
          schema:
            type:
              - array
              - 'null'
            items:
              type: string
        - name: contact_id
          in: query
          description: Filter by contact IDs (comma-separated)
          required: false
          schema:
            type:
              - array
              - 'null'
            items:
              type: string
        - name: user_id
          in: query
          description: Filter by user IDs (comma-separated)
          required: false
          schema:
            type:
              - array
              - 'null'
            items:
              type: string
        - name: organization_id
          in: query
          required: false
          schema:
            type:
              - string
              - 'null'
        - name: _type
          in: query
          description: Filter by activity type, e.g. Call (comma-separated)
          required: false
          schema:
            type:
              - array
              - 'null'
            items:
              type: string
        - name: date_created__gte
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/ActivityCustomGetParametersDateCreatedGte'
        - name: date_created__lte
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/ActivityCustomGetParametersDateCreatedLte'
        - name: date_created__gt
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/ActivityCustomGetParametersDateCreatedGt'
        - name: date_created__lt
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/ActivityCustomGetParametersDateCreatedLt'
        - name: activity_at__gte
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/ActivityCustomGetParametersActivityAtGte'
        - name: activity_at__lte
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/ActivityCustomGetParametersActivityAtLte'
        - name: activity_at__gt
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/ActivityCustomGetParametersActivityAtGt'
        - name: activity_at__lt
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/ActivityCustomGetParametersActivityAtLt'
        - name: custom_activity_type_id
          in: query
          required: false
          schema:
            type:
              - array
              - 'null'
            items:
              type: string
        - name: custom_activity_type_id__in
          in: query
          required: false
          schema:
            type: string
        - name: Authorization
          in: header
          description: Basic authentication
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/activities.custom_activities_list_Response_200
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                description: Any type
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                description: Any type
        '404':
          description: Not found
          content:
            application/json:
              schema:
                description: Any type
servers:
  - url: https://api.close.com/api/v1
components:
  schemas:
    ActivityCustomGetParametersDateCreatedGte:
      oneOf:
        - type: string
          format: date-time
        - type: string
          format: date
      title: ActivityCustomGetParametersDateCreatedGte
    ActivityCustomGetParametersDateCreatedLte:
      oneOf:
        - type: string
          format: date-time
        - type: string
          format: date
      title: ActivityCustomGetParametersDateCreatedLte
    ActivityCustomGetParametersDateCreatedGt:
      oneOf:
        - type: string
          format: date-time
        - type: string
          format: date
      title: ActivityCustomGetParametersDateCreatedGt
    ActivityCustomGetParametersDateCreatedLt:
      oneOf:
        - type: string
          format: date-time
        - type: string
          format: date
      title: ActivityCustomGetParametersDateCreatedLt
    ActivityCustomGetParametersActivityAtGte:
      oneOf:
        - type: string
          format: date-time
        - type: string
          format: date
      title: ActivityCustomGetParametersActivityAtGte
    ActivityCustomGetParametersActivityAtLte:
      oneOf:
        - type: string
          format: date-time
        - type: string
          format: date
      title: ActivityCustomGetParametersActivityAtLte
    ActivityCustomGetParametersActivityAtGt:
      oneOf:
        - type: string
          format: date-time
        - type: string
          format: date
      title: ActivityCustomGetParametersActivityAtGt
    ActivityCustomGetParametersActivityAtLt:
      oneOf:
        - type: string
          format: date-time
        - type: string
          format: date
      title: ActivityCustomGetParametersActivityAtLt
    activities.custom_activities_list_Response_200:
      type: object
      properties: {}
      description: Empty response body
      title: activities.custom_activities_list_Response_200
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: basic
    OAuth2:
      type: http
      scheme: bearer

```