infoodle

List custom fields

GET /customfield/list
OAuth2

List all the custom fields available in the system

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • id integer
    • name string
    • field_type string
    • is_search_field integer

      Values are 0 or 1.

    • also_update string

      Whether to ask to update

      • just the current contact
      • S: also the spouse in this household
      • H: also everyone in the household
    • ask_when_adding integer

      Values are 0 or 1.

    • lookup_key_id integer

      id of the Lookup list this field is connected to

    • connector_label string

      When the field type is P this label is used for the mentor

    • connectee_label string

      When the field type is P this label is used for the mentee

    • is_mandatory integer

      Whether this field is mandatory

      Values are 0 or 1.

    • is_contact_type_field integer

      Only for field type L (lookup). Identifies if its the contact field. Only 1 field can be set to 1

      Values are 0 or 1.
GET /customfield/list 
curl \
 --request GET 'https://YOURSITE.infoodle.com/apiv2/customfield/list' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
[
  {
    "id": 234,
    "name": "School year",
    "field_type": "L",
    "is_search_field": 0,
    "also_update": "H",
    "ask_when_adding": 0,
    "lookup_key_id": 6,
    "connector_label": "Mentor",
    "connectee_label": "Mentee",
    "is_mandatory": 0,
    "is_contact_type_field": 0
  }
]