Skip to content

Groups Settings

Jump to bottom
corsacca edited this page Apr 18, 2019 · 1 revision

Endpoint

GET https://example.com/wp-json/dt/v1/groups/settings

Returns

{
  'sources': {}, //the list of sources
  'fields': {}, // the list of contact fields
  'address_types': {},
  'channels': {},
  'connection_types': []
}

What each field might look like

Fields Example

fields: {
      "group_type": {
            "name": "Group Type",
            "description": "",
            "type": "key_select",
            "default": {
                "pre-group": {
                    "label": "Pre-Group"
                },
                "group": {
                    "label": "Group"
                },
                "church": {
                    "label": "Church"
                }
            },
            "section": "info",
            "customizable": "add_only"
        },
        "assigned_to": {
            "name": "Assigned To",
            "description": "",
            "type": "user_select",
            "default": "",
            "section": "info"
        },
        ...
}

Address_types Example

address_types: {
 {
        "main": {
            "label": "Main"
        },
        "alternate": {
            "label": "Alternate"
        }
    }
}

Channels Example

channels: [
       "address"
]

Connection Types

connection_types: [
        "members",
        "parent_groups",
        "child_groups",
        "peer_groups",
        "locations",
        "people_groups",
        "leaders",
        "coaches"
    ]

Developer Documentation

Clone this wiki locally