CLclose
activities.custom_activities

List or filter all Custom Activity instances

Changed on

Custom Fields appear in the format: custom.{custom_field_id}. See 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 and provide those Lead IDs one at a time to this endpoint.

get/activity/custom/

Request

  • Base URL
    https://api.close.com/api/v1
  • URL
    https://api.close.com/api/v1/activity/custom/
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://app.close.com/oauth2/authorize/
      Token URL: https://api.close.com/oauth2/token/

Query parameters

_limitinteger

Number of results to return.

_skipinteger

Number of results to skip before returning, for pagination. The maximum is 35,000 for some organizations.

id__instring[] nullable

Filter by activity IDs (comma-separated)

lead_idstring[] nullable

Filter by lead IDs (comma-separated)

contact_idstring[] nullable

Filter by contact IDs (comma-separated)

user_idstring[] nullable

Filter by user IDs (comma-separated)

organization_idstring nullable
_typestring[] nullable

Filter by activity type, e.g. Call (comma-separated)

string date-time
OR
string date
string date-time
OR
string date
string date-time
OR
string date
string date-time
OR
string date
string date-time
OR
string date
string date-time
OR
string date
string date-time
OR
string date
string date-time
OR
string date
custom_activity_type_idstring[] nullable
custom_activity_type_id__instring
_fieldsstring

Comma-separated list of fields to include in the response.

Response

Successful response

has_moreboolean required

Changes

  • 8e360c61058cRevision changes
    • info

      added the pattern property ^custom\.(cf|lcf|ccf|acf|gcf|scf)_[A-Za-z0-9]+$ to the / response property for the status

  • 7bdb9cfcca22Revision changes
    • warning

      for the query request parameter _limit, the max was set to 100.00

    • warning

      for the query request parameter _skip, the max was set to 250000.00