List Custom Object instances | Close | Developer API Documentation

curl -G https://api.close.com/api/v1/custom_object/ \
     -u "<CLOSE_API_KEY>:" \
     -d lead_id=lead_id

{
  "data": [
    {
      "created_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
      "custom.cf_jnxTQDKnSxCEBtD5dvZdNgTzC3CqeyWUyU349PBA9Wf": "custobj_v0VS1AZAg8LjnpBm1hZz83UZ3yWK0n9SdVV5i8yC6he",
      "custom_object_type_id": "cotype_1h5m6uHM9BZOpwVhyRJb4Y",
      "date_created": "2020-08-04T16:45:35.367000+00:00",
      "date_updated": "2020-08-04T17:37:56.439000+00:00",
      "id": "custobj_5J7mimiIKB1tQ3gVduP0c4UhXbNj5ptMLteAWRJu7Sf",
      "lead_id": "lead_hwnL36A2iEMSLIlmGhsdrcmOJzTUzqEHwr66wrA1K2T",
      "name": "Resource",
      "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
      "updated_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk"
    },
    {
      "created_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
      "custom.cf_UpyNBvr6Rw8UBHh7zRboL3PYhbOVJl3XvwgPm3jg64S": "cont_aHtUny9tps9LjJ8Cc5SP1NY3826j6PdNML9ZfkSUHyc",
      "custom.cf_cSh3fWT3rEJ1BFSezme2YAG6bPrZV5wUWKKrW4iN19g": "Potential",
      "custom_object_type_id": "cotype_4hQsScWF3hnUOyngoaAV00",
      "date_created": "2020-08-04T16:45:29.612000+00:00",
      "date_updated": "2020-08-04T16:46:02.705000+00:00",
      "id": "custobj_v0VS1AZAg8LjnpBm1hZz83UZ3yWK0n9SdVV5i8yC6he",
      "lead_id": "lead_hwnL36A2iEMSLIlmGhsdrcmOJzTUzqEHwr66wrA1K2T",
      "name": "Primary Account",
      "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
      "updated_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk"
    }
  ],
  "has_more": false
}

The `lead_id` parameter is required. If you want to retrieve all Custom Object instances regardless of the lead, you will need to use [Advanced Filtering](https://developer.close.com/api/resources/advanced-filtering). Custom Fields values appear in the format: `custom.{custom_field_id}`. See [Custom Fields](https://developer.close.com/api/resources/custom-fields/custom-fields-custom-object). Back references to each Custom Object are not collected in this response. If you need to access this information, please use the `back_reference_fields` on the Custom Object Type and [Advanced Filtering](https://developer.close.com/api/resources/advanced-filtering) to search for objects that reference the Custom Object Instance.

curl -G https://api.close.com/api/v1/custom_object/ \
     -u "<CLOSE_API_KEY>:" \
     -d lead_id=lead_id

{
  "data": [
    {
      "created_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
      "custom.cf_jnxTQDKnSxCEBtD5dvZdNgTzC3CqeyWUyU349PBA9Wf": "custobj_v0VS1AZAg8LjnpBm1hZz83UZ3yWK0n9SdVV5i8yC6he",
      "custom_object_type_id": "cotype_1h5m6uHM9BZOpwVhyRJb4Y",
      "date_created": "2020-08-04T16:45:35.367000+00:00",
      "date_updated": "2020-08-04T17:37:56.439000+00:00",
      "id": "custobj_5J7mimiIKB1tQ3gVduP0c4UhXbNj5ptMLteAWRJu7Sf",
      "lead_id": "lead_hwnL36A2iEMSLIlmGhsdrcmOJzTUzqEHwr66wrA1K2T",
      "name": "Resource",
      "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
      "updated_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk"
    },
    {
      "created_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
      "custom.cf_UpyNBvr6Rw8UBHh7zRboL3PYhbOVJl3XvwgPm3jg64S": "cont_aHtUny9tps9LjJ8Cc5SP1NY3826j6PdNML9ZfkSUHyc",
      "custom.cf_cSh3fWT3rEJ1BFSezme2YAG6bPrZV5wUWKKrW4iN19g": "Potential",
      "custom_object_type_id": "cotype_4hQsScWF3hnUOyngoaAV00",
      "date_created": "2020-08-04T16:45:29.612000+00:00",
      "date_updated": "2020-08-04T16:46:02.705000+00:00",
      "id": "custobj_v0VS1AZAg8LjnpBm1hZz83UZ3yWK0n9SdVV5i8yC6he",
      "lead_id": "lead_hwnL36A2iEMSLIlmGhsdrcmOJzTUzqEHwr66wrA1K2T",
      "name": "Primary Account",
      "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
      "updated_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk"
    }
  ],
  "has_more": false
}

The lead_id parameter is required. If you want to retrieve all Custom Object instances regardless of the lead, you will need to use Advanced Filtering.

Custom Fields values appear in the format: custom.{custom_field_id}. See Custom Fields.

Back references to each Custom Object are not collected in this response. If you need to access this information, please use the back_reference_fields on the Custom Object Type and Advanced Filtering to search for objects that reference the Custom Object Instance.

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

lead_idstringRequired

custom_object_type_idstring or nullOptional

Response

Successful response

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

$	curl -G https://api.close.com/api/v1/custom_object/ \
>	-u "<CLOSE_API_KEY>:" \
>	-d lead_id=lead_id

1	{
2	"data": [
3	{
4	"created_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
5	"custom.cf_jnxTQDKnSxCEBtD5dvZdNgTzC3CqeyWUyU349PBA9Wf": "custobj_v0VS1AZAg8LjnpBm1hZz83UZ3yWK0n9SdVV5i8yC6he",
6	"custom_object_type_id": "cotype_1h5m6uHM9BZOpwVhyRJb4Y",
7	"date_created": "2020-08-04T16:45:35.367000+00:00",
8	"date_updated": "2020-08-04T17:37:56.439000+00:00",
9	"id": "custobj_5J7mimiIKB1tQ3gVduP0c4UhXbNj5ptMLteAWRJu7Sf",
10	"lead_id": "lead_hwnL36A2iEMSLIlmGhsdrcmOJzTUzqEHwr66wrA1K2T",
11	"name": "Resource",
12	"organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
13	"updated_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk"
14	},
15	{
16	"created_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
17	"custom.cf_UpyNBvr6Rw8UBHh7zRboL3PYhbOVJl3XvwgPm3jg64S": "cont_aHtUny9tps9LjJ8Cc5SP1NY3826j6PdNML9ZfkSUHyc",
18	"custom.cf_cSh3fWT3rEJ1BFSezme2YAG6bPrZV5wUWKKrW4iN19g": "Potential",
19	"custom_object_type_id": "cotype_4hQsScWF3hnUOyngoaAV00",
20	"date_created": "2020-08-04T16:45:29.612000+00:00",
21	"date_updated": "2020-08-04T16:46:02.705000+00:00",
22	"id": "custobj_v0VS1AZAg8LjnpBm1hZz83UZ3yWK0n9SdVV5i8yC6he",
23	"lead_id": "lead_hwnL36A2iEMSLIlmGhsdrcmOJzTUzqEHwr66wrA1K2T",
24	"name": "Primary Account",
25	"organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
26	"updated_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk"
27	}
28	],
29	"has_more": false
30	}