Retrieve a single Custom Activity Type | Close

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

{
  "api_create_only": false,
  "created_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
  "date_created": "2020-07-27T21:28:39.765523",
  "date_updated": "2020-07-27T21:28:39.765523",
  "description": "Heppens when the lead signs up for the newsletter",
  "editable_with_roles": [],
  "fields": [
    {
      "accepts_multiple_values": false,
      "converting_to_type": null,
      "description": "Email of the person who signed up for the newsletter",
      "editable_with_roles": [],
      "id": "cf_UpyNBvr6Rw8UBHh7zRboL3PYhbOVJl3XvwgPm3jg64S",
      "name": "Email Address",
      "required": true,
      "type": "text"
    },
    {
      "accepts_multiple_values": true,
      "converting_to_type": null,
      "description": null,
      "editable_with_roles": [],
      "id": "cf_cSh3fWT3rEJ1BFSezme2YAG6bPrZV5wUWKKrW4iN19g",
      "name": "Wants Marketing Materials",
      "required": false,
      "type": "choices"
    }
  ],
  "id": "actitype_1h5m6uHM9BZOpwVhyRJb4Y",
  "is_archived": false,
  "name": "Newsletter Signup",
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "updated_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk"
}

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

{
  "api_create_only": false,
  "created_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
  "date_created": "2020-07-27T21:28:39.765523",
  "date_updated": "2020-07-27T21:28:39.765523",
  "description": "Heppens when the lead signs up for the newsletter",
  "editable_with_roles": [],
  "fields": [
    {
      "accepts_multiple_values": false,
      "converting_to_type": null,
      "description": "Email of the person who signed up for the newsletter",
      "editable_with_roles": [],
      "id": "cf_UpyNBvr6Rw8UBHh7zRboL3PYhbOVJl3XvwgPm3jg64S",
      "name": "Email Address",
      "required": true,
      "type": "text"
    },
    {
      "accepts_multiple_values": true,
      "converting_to_type": null,
      "description": null,
      "editable_with_roles": [],
      "id": "cf_cSh3fWT3rEJ1BFSezme2YAG6bPrZV5wUWKKrW4iN19g",
      "name": "Wants Marketing Materials",
      "required": false,
      "type": "choices"
    }
  ],
  "id": "actitype_1h5m6uHM9BZOpwVhyRJb4Y",
  "is_archived": false,
  "name": "Newsletter Signup",
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "updated_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk"
}

The response contains the Custom Activity Type including most 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.

Path parameters

idstringRequired

Response

Successful response

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

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

1	{
2	"api_create_only": false,
3	"created_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
4	"date_created": "2020-07-27T21:28:39.765523",
5	"date_updated": "2020-07-27T21:28:39.765523",
6	"description": "Heppens when the lead signs up for the newsletter",
7	"editable_with_roles": [],
8	"fields": [
9	{
10	"accepts_multiple_values": false,
11	"converting_to_type": null,
12	"description": "Email of the person who signed up for the newsletter",
13	"editable_with_roles": [],
14	"id": "cf_UpyNBvr6Rw8UBHh7zRboL3PYhbOVJl3XvwgPm3jg64S",
15	"name": "Email Address",
16	"required": true,
17	"type": "text"
18	},
19	{
20	"accepts_multiple_values": true,
21	"converting_to_type": null,
22	"description": null,
23	"editable_with_roles": [],
24	"id": "cf_cSh3fWT3rEJ1BFSezme2YAG6bPrZV5wUWKKrW4iN19g",
25	"name": "Wants Marketing Materials",
26	"required": false,
27	"type": "choices"
28	}
29	],
30	"id": "actitype_1h5m6uHM9BZOpwVhyRJb4Y",
31	"is_archived": false,
32	"name": "Newsletter Signup",
33	"organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
34	"updated_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk"
35	}