List Custom Activity Types

GET

https://api.close.com/api/v1/custom_activity/

GET

/api/v1/custom_activity/

1 curl https://api.close.com/api/v1/custom_activity/ \
2      -u "<CLOSE_API_KEY>:"

1 {
2   "data": [
3     {
4       "api_create_only": true,
5       "created_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
6       "date_created": "2020-07-09T15:36:16.795350",
7       "date_updated": "2020-07-09T15:36:16.795350",
8       "description": "An API event only, with no fields.",
9       "editable_with_roles": [],
10       "fields": [],
11       "id": "actitype_33dpZWDiI0KoJsmQFCKbgi",
12       "is_archived": false,
13       "name": "API Event",
14       "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
15       "updated_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk"
16     },
17     {
18       "api_create_only": false,
19       "created_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
20       "date_created": "2020-07-27T21:28:39.765523",
21       "date_updated": "2020-07-27T21:28:39.765523",
22       "description": "Heppens when the lead signs up for the newsletter",
23       "editable_with_roles": [],
24       "fields": [
25         {
26           "accepts_multiple_values": false,
27           "description": "Email of the person who signed up for the newsletter",
28           "editable_with_roles": [],
29           "id": "cf_UpyNBvr6Rw8UBHh7zRboL3PYhbOVJl3XvwgPm3jg64S",
30           "name": "Email Address",
31           "required": true,
32           "type": "text"
33         },
34         {
35           "accepts_multiple_values": true,
36           "editable_with_roles": [],
37           "id": "cf_cSh3fWT3rEJ1BFSezme2YAG6bPrZV5wUWKKrW4iN19g",
38           "name": "Wants Marketing Materials",
39           "required": false,
40           "type": "choices"
41         }
42       ],
43       "id": "actitype_1h5m6uHM9BZOpwVhyRJb4Y",
44       "is_archived": false,
45       "name": "Newsletter Signup",
46       "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
47       "updated_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk"
48     }
49   ]
50 }

List all custom activity types defined in the organization. The response includes all Custom Activity Types, including their Custom Field metadata.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:)>.

AuthorizationBearer

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

Response

Successful response

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error