List Lead Custom Fields | Close | Developer API Documentation

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

{
  "data": [
    {
      "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_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
      "type": "number",
      "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
    },
    {
      "accepts_multiple_values": true,
      "choices": [
        "Apparel",
        "Cars",
        "Cosmetics",
        "IT"
      ],
      "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
      "date_created": "2014-11-07T05:06:09.423000+00:00",
      "date_updated": "2014-11-12T22:37:55.752000+00:00",
      "description": null,
      "editable_with_roles": [],
      "id": "cf_8wtBWsdRU2Fur7GDnEeXQ7ra2Vu7R4hG1SNYdiEhh0F",
      "name": "Industry",
      "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
      "type": "choices",
      "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
    },
    {
      "accepts_multiple_values": false,
      "choices": null,
      "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
      "date_created": "2014-11-10T23:38:14.535000+00:00",
      "date_updated": "2014-11-10T23:38:14.535000+00:00",
      "description": "ID in the company database",
      "editable_with_roles": [
        "admin",
        "role_4zhUd9gDKwVv0Bbl2Nk0Ud"
      ],
      "id": "cf_vvHHPVktybLXXqKrUF88PLsGm8sh202oMq3XGy6RcBm",
      "name": "Internal Database ID",
      "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
      "type": "text",
      "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
    },
    {
      "accepts_multiple_values": false,
      "choices": null,
      "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
      "date_created": "2014-11-10T20:56:44.780000+00:00",
      "date_updated": "2014-11-10T20:56:44.780000+00:00",
      "description": null,
      "editable_with_roles": [],
      "id": "cf_xUDvptVqoPQYv5tmRFDxemYOWFT9nlLRqJyQhpcNh4z",
      "name": "Language Preference",
      "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
      "type": "text",
      "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
    },
    {
      "accepts_multiple_values": false,
      "choices": null,
      "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
      "date_created": "2014-11-07T05:06:09.413000+00:00",
      "date_updated": "2014-11-10T20:51:12.636000+00:00",
      "description": "The date the trial expires",
      "editable_with_roles": [],
      "id": "cf_MakiQgTzKXrcL8sDJbS2lkuUcA2FxZJAW8Q38ARgwWh",
      "name": "Trial Due",
      "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
      "type": "date",
      "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
    },
    {
      "accepts_multiple_values": false,
      "choices": null,
      "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
      "date_created": "2014-11-07T05:06:09.413000+00:00",
      "date_updated": "2014-11-10T20:51:12.636000+00:00",
      "description": "The AE in charge of this account",
      "editable_with_roles": [],
      "id": "cf_MakiQgTzKXrcL8sDJbS2lkuUcA2FxZJAW8Q38ARgwWh",
      "name": "Owner",
      "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
      "type": "user",
      "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
    }
  ],
  "has_more": false
}

List all the lead custom fields for your organization.

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

_limitintegerOptionalDefaults to 100

Number of results to return.

_skipintegerOptionalDefaults to 0

Number of results to skip before returning, for pagination.

_fieldsstringOptional

Comma-separated list of fields to include in the response.

Response

Successful response

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error