Contacts Custom Fields

GET custom_fields Collection

Changed on

Get all custom fields defined in the user's account.

<div class="Msg"><p class="note-text">This method does not currently support filtering results using the custom field update date.</p></div>
get/contact_custom_fields

Request

  • Base URL
    https://api.cc.email/v3
  • URL
    https://api.cc.email/v3/contact_custom_fields
  • Auth
    • OAuth 2
      Implicit: https://authz.constantcontact.com/oauth2/default/v1/authorize
      Scopes: contact_data
    • or OAuth 2
      Authorization code: https://authz.constantcontact.com/oauth2/default/v1/authorize
      Token URL: https://authz.constantcontact.com/oauth2/default/v1/token scopes: contact_data

Query parameters

limitinteger

Specifies the number of results displayed per page of output, from 1 - 100, default = 50.

Response

Request successful

Example response

{
  "custom_fields": [
    {
      "custom_field_id": "1618ae62-4752-11e9-9c8a-fa163e6b01c1",
      "label": "Vehicle make and model year",
      "name": "Vehicle_make_and_model_year",
      "type": "date",
      "metadata": {
        "display_type": "radio",
        "decimal_places": 1,
        "currency_code": "USD",
        "integer": true,
        "display_format": "MM/DD/YYYY"
      },
      "version": 1,
      "choices": [
        {
          "custom_field_id": "d0737000-afbf-11ee-874a-eaf5d7a2e15d",
          "choice_label": "Apple",
          "display_order": 1,
          "created_at": "2024-06-27T10:28:09.000Z",
          "updated_at": "2024-06-27T10:28:09.000Z",
          "deleted_at": "2023-12-18"
        }
      ],
      "updated_at": "2016-01-23T13:48:44.108Z",
      "created_at": "2016-03-03T10:53:04-05:00"
    }
  ],
  "_links": {
    "next": {
      "href": "/v3/activities/04fe9a97-a579-43c5-bb1a-58ed29bf0a6a"
    }
  }
}

Changes