List Custom Activity Types

GET

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

GET

/api/v1/custom_activity/

$ curl https://api.close.com/api/v1/custom_activity/ \
>      -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           "converting_to_type": null,
28           "description": "Email of the person who signed up for the newsletter",
29           "editable_with_roles": [],
30           "id": "cf_UpyNBvr6Rw8UBHh7zRboL3PYhbOVJl3XvwgPm3jg64S",
31           "name": "Email Address",
32           "required": true,
33           "type": "text"
34         },
35         {
36           "accepts_multiple_values": true,
37           "converting_to_type": null,
38           "description": null,
39           "editable_with_roles": [],
40           "id": "cf_cSh3fWT3rEJ1BFSezme2YAG6bPrZV5wUWKKrW4iN19g",
41           "name": "Wants Marketing Materials",
42           "required": false,
43           "type": "choices"
44         }
45       ],
46       "id": "actitype_1h5m6uHM9BZOpwVhyRJb4Y",
47       "is_archived": false,
48       "name": "Newsletter Signup",
49       "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
50       "updated_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk"
51     }
52   ]
53 }

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

List Custom Activity Types

GET

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

GET

/api/v1/custom_activity/

$ curl https://api.close.com/api/v1/custom_activity/ \
>      -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           "converting_to_type": null,
28           "description": "Email of the person who signed up for the newsletter",
29           "editable_with_roles": [],
30           "id": "cf_UpyNBvr6Rw8UBHh7zRboL3PYhbOVJl3XvwgPm3jg64S",
31           "name": "Email Address",
32           "required": true,
33           "type": "text"
34         },
35         {
36           "accepts_multiple_values": true,
37           "converting_to_type": null,
38           "description": null,
39           "editable_with_roles": [],
40           "id": "cf_cSh3fWT3rEJ1BFSezme2YAG6bPrZV5wUWKKrW4iN19g",
41           "name": "Wants Marketing Materials",
42           "required": false,
43           "type": "choices"
44         }
45       ],
46       "id": "actitype_1h5m6uHM9BZOpwVhyRJb4Y",
47       "is_archived": false,
48       "name": "Newsletter Signup",
49       "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
50       "updated_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk"
51     }
52   ]
53 }

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

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.

Response

Successful response

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

$	curl https://api.close.com/api/v1/custom_activity/ \
>	-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	"converting_to_type": null,
28	"description": "Email of the person who signed up for the newsletter",
29	"editable_with_roles": [],
30	"id": "cf_UpyNBvr6Rw8UBHh7zRboL3PYhbOVJl3XvwgPm3jg64S",
31	"name": "Email Address",
32	"required": true,
33	"type": "text"
34	},
35	{
36	"accepts_multiple_values": true,
37	"converting_to_type": null,
38	"description": null,
39	"editable_with_roles": [],
40	"id": "cf_cSh3fWT3rEJ1BFSezme2YAG6bPrZV5wUWKKrW4iN19g",
41	"name": "Wants Marketing Materials",
42	"required": false,
43	"type": "choices"
44	}
45	],
46	"id": "actitype_1h5m6uHM9BZOpwVhyRJb4Y",
47	"is_archived": false,
48	"name": "Newsletter Signup",
49	"organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
50	"updated_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk"
51	}
52	]
53	}