Retrieve a custom field schema | Close | Developer API Documentation

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

{
  "fields": [
    {
      "accepts_multiple_values": false,
      "choices": null,
      "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
      "date_created": "2014-11-07T05:06:09.422000+00:00",
      "date_updated": "2014-11-10T20:56:16.784000+00:00",
      "description": "The number of users in the company",
      "editable_with_roles": [],
      "id": "cf_v6S011I6MqcbVvB2FA5Nk8dr5MkL8sWuCiG8cUleO9c",
      "name": "# of users",
      "organization_id": "orga_vfvFDAKGLybddKDJn8n7ElZZ3qyRF3QI8fJxTSAYr5X",
      "type": "number",
      "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
    },
    {
      "accepts_multiple_values": false,
      "associations": [
        {
          "editable_with_roles": [],
          "object_type": "lead",
          "required": false
        },
        {
          "editable_with_roles": [],
          "object_type": "contact",
          "required": false
        },
        {
          "custom_activity_type_id": "actitype_2FqdeKTAEfMTwD4SVWwXqX",
          "editable_with_roles": [],
          "object_type": "custom_activity_type",
          "required": true
        }
      ],
      "created_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
      "date_created": "2021-04-10T17:36:09.235000+00:00",
      "date_updated": "2021-04-10T17:36:09.235000+00:00",
      "description": "User responsible for this Lead/Contact/Activity.",
      "id": "cf_aU54Bvr6Rw8UBHh7zRboL3PYhbOVJl3XvwgPm3jgaKq",
      "name": "Owner",
      "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
      "type": "user",
      "updated_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk"
    }
  ],
  "name": "Lead",
  "object_type": "lead",
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH"
}

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

{
  "fields": [
    {
      "accepts_multiple_values": false,
      "choices": null,
      "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
      "date_created": "2014-11-07T05:06:09.422000+00:00",
      "date_updated": "2014-11-10T20:56:16.784000+00:00",
      "description": "The number of users in the company",
      "editable_with_roles": [],
      "id": "cf_v6S011I6MqcbVvB2FA5Nk8dr5MkL8sWuCiG8cUleO9c",
      "name": "# of users",
      "organization_id": "orga_vfvFDAKGLybddKDJn8n7ElZZ3qyRF3QI8fJxTSAYr5X",
      "type": "number",
      "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
    },
    {
      "accepts_multiple_values": false,
      "associations": [
        {
          "editable_with_roles": [],
          "object_type": "lead",
          "required": false
        },
        {
          "editable_with_roles": [],
          "object_type": "contact",
          "required": false
        },
        {
          "custom_activity_type_id": "actitype_2FqdeKTAEfMTwD4SVWwXqX",
          "editable_with_roles": [],
          "object_type": "custom_activity_type",
          "required": true
        }
      ],
      "created_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
      "date_created": "2021-04-10T17:36:09.235000+00:00",
      "date_updated": "2021-04-10T17:36:09.235000+00:00",
      "description": "User responsible for this Lead/Contact/Activity.",
      "id": "cf_aU54Bvr6Rw8UBHh7zRboL3PYhbOVJl3XvwgPm3jgaKq",
      "name": "Owner",
      "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
      "type": "user",
      "updated_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk"
    }
  ],
  "name": "Lead",
  "object_type": "lead",
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH"
}

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

object_typestringRequired

Response

Successful response

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

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

1	{
2	"fields": [
3	{
4	"accepts_multiple_values": false,
5	"choices": null,
6	"created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
7	"date_created": "2014-11-07T05:06:09.422000+00:00",
8	"date_updated": "2014-11-10T20:56:16.784000+00:00",
9	"description": "The number of users in the company",
10	"editable_with_roles": [],
11	"id": "cf_v6S011I6MqcbVvB2FA5Nk8dr5MkL8sWuCiG8cUleO9c",
12	"name": "# of users",
13	"organization_id": "orga_vfvFDAKGLybddKDJn8n7ElZZ3qyRF3QI8fJxTSAYr5X",
14	"type": "number",
15	"updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
16	},
17	{
18	"accepts_multiple_values": false,
19	"associations": [
20	{
21	"editable_with_roles": [],
22	"object_type": "lead",
23	"required": false
24	},
25	{
26	"editable_with_roles": [],
27	"object_type": "contact",
28	"required": false
29	},
30	{
31	"custom_activity_type_id": "actitype_2FqdeKTAEfMTwD4SVWwXqX",
32	"editable_with_roles": [],
33	"object_type": "custom_activity_type",
34	"required": true
35	}
36	],
37	"created_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
38	"date_created": "2021-04-10T17:36:09.235000+00:00",
39	"date_updated": "2021-04-10T17:36:09.235000+00:00",
40	"description": "User responsible for this Lead/Contact/Activity.",
41	"id": "cf_aU54Bvr6Rw8UBHh7zRboL3PYhbOVJl3XvwgPm3jgaKq",
42	"name": "Owner",
43	"organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
44	"type": "user",
45	"updated_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk"
46	}
47	],
48	"name": "Lead",
49	"object_type": "lead",
50	"organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH"
51	}