List or filter all Custom Activity instances

GET

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

GET

/api/v1/activity/custom/

curl https://api.close.com/api/v1/activity/custom/ \
     -u "<CLOSE_API_KEY>:"

{
  "data": [
    {
      "_type": "CustomActivity",
      "activity_at": "2020-08-04T16:45:35.367000+00:00",
      "contact_id": null,
      "created_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
      "custom_activity_type_id": "actitype_1h5m6uHM9BZOpwVhyRJb4Y",
      "date_created": "2020-08-04T16:45:35.367000+00:00",
      "date_updated": "2020-08-04T17:37:56.439000+00:00",
      "id": "acti_5J7mimiIKB1tQ3gVduP0c4UhXbNj5ptMLteAWRJu7Sf",
      "last_published_at": null,
      "lead_id": "lead_hwnL36A2iEMSLIlmGhsdrcmOJzTUzqEHwr66wrA1K2T",
      "mentions": [],
      "mentions_updated_at": null,
      "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
      "pinned": false,
      "pinned_at": null,
      "source": "ui",
      "status": "draft",
      "updated_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
      "user_id": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
      "users": [],
      "created_by_name": "Bruce Wayne",
      "updated_by_name": "Bruce Wayne",
      "user_name": "Bruce Wayne",
      "custom.cf_cSh3fWT3rEJ1BFSezme2YAG6bPrZV5wUWKKrW4iN19g": "Yes"
    },
    {
      "_type": "CustomActivity",
      "activity_at": "2020-08-04T16:45:29.612000+00:00",
      "contact_id": null,
      "created_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
      "custom_activity_type_id": "actitype_33dpZWDiI0KoJsmQFCKbgi",
      "date_created": "2020-08-04T16:45:29.612000+00:00",
      "date_updated": "2020-08-04T16:46:02.705000+00:00",
      "id": "acti_v0VS1AZAg8LjnpBm1hZz83UZ3yWK0n9SdVV5i8yC6he",
      "last_published_at": "2020-08-04T16:45:29.612000+00:00",
      "lead_id": "lead_hwnL36A2iEMSLIlmGhsdrcmOJzTUzqEHwr66wrA1K2T",
      "mentions": [],
      "mentions_updated_at": null,
      "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
      "pinned": false,
      "pinned_at": null,
      "source": "ui",
      "status": "published",
      "updated_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
      "user_id": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
      "users": [],
      "created_by_name": "Bruce Wayne",
      "updated_by_name": "Bruce Wayne",
      "user_name": "Bruce Wayne"
    }
  ],
  "has_more": false
}

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.

Authentication

AuthorizationBasic

Use your API key as the username and leave the password empty.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

_limitintegerOptionalDefaults to 100

Number of results to return.

_skipintegerOptionalDefaults to 0

Number of results to skip before returning, for pagination.

id__inlist of strings or nullOptional

Filter by activity IDs (comma-separated)

lead_idlist of strings or nullOptional

Filter by lead IDs (comma-separated)

contact_idlist of strings or nullOptional

Filter by contact IDs (comma-separated)

user_idlist of strings or nullOptional

Filter by user IDs (comma-separated)

organization_idstring or nullOptional

_typelist of strings or nullOptional

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

date_created__gtedatetime or dateOptional

date_created__ltedatetime or dateOptional

date_created__gtdatetime or dateOptional

date_created__ltdatetime or dateOptional

activity_at__gtedatetime or dateOptional

activity_at__ltedatetime or dateOptional

activity_at__gtdatetime or dateOptional

activity_at__ltdatetime or dateOptional

custom_activity_type_idlist of strings or nullOptional

custom_activity_type_id__instringOptional

_fieldsstringOptional

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

Response

Successful response

datalist of objects

has_moreboolean

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error