Dev Docs
  • Disciple.Tools Technical Documentation
  • Theme Core
    • API - Posts
      • List of Endpoints
      • Fields Format
      • Get Post
      • Create Post
      • Update Post
      • Post Comments
      • Post Activity
      • List Query
      • Global Search
      • Posts in Typeaheads
      • Post-Sharing
      • Get Following
      • Settings
    • API - Other
      • Users
      • Locations
      • Settings
    • Hooks
      • Record Page Hooks
      • API-Hooks
      • Public settings
      • Adding menu navigation links
    • Customization
      • Fields
      • Custom Post Types
      • Post Type Modules
      • Adding Fields and Tiles.
    • Authentication
      • JWT-Authentication-for-the-mobile-app
      • Site-to-Site-Link
      • Easy-Example
    • Permissions
    • Roles and Permissions
    • Database Tables
      • Activity Table
    • Disciple.Tools Translation
    • Revisions
      • v1.0.0-dev-changes
      • v1.0
  • Hosting
    • 404 Errors on new install
    • CRON
    • Hosting on WPEngine
    • Backups
    • Single Site or MultiSite
  • Disciple.Tools Development Setup
    • LocalWP
    • Mobile App Setup
    • Unit Tests
    • Cypress Tests
    • D.T on Docker Setup
    • Gulp - CSS and JS
  • Code Contribution
    • Theme Contribution Guidelines
    • How to Correctly Contribute to the Disciple Tools Repository
    • How to Translate Your Plugin
  • Style Guide
  • Disciple.Tools Code of Conduct
Powered by GitBook
On this page
  • Get Settings
  • Return

Was this helpful?

Edit on Git
  1. Theme Core
  2. API - Posts

Settings

PreviousGet FollowingNextAPI - Other

Last updated 3 years ago

Was this helpful?

Get Settings

Get

Return

(object) the settings object

Example format:

{
  "tiles":
  {
    "status":{"label":"Status","tile_priority":10,"order":["overall_status","assigned_to","subassigned"]},
    "details":{"label":"Details","tile_priority":20,"order":["name","nickname","contact_phone","contact_email","location_grid","location_grid_meta","contact_address","contact_facebook","contact_twitter","contact_other","gender","age","baptism_date","sources","campaigns","people_groups"]},
    //etc
  },
  "fields":{ 
    "name":{"name":"Name","type":"text","tile":"details","in_create_form":true,"required":true,"icon":"http:\/\/example.com\/wp-content\/themes\/disciple-tools-theme\/dt-assets\/images\/name.svg","show_in_table":5},
    "last_modified":{"name":"Last Modified","type":"date","default":0,"customizable":false,"show_in_table":100},
    "post_date":{"name":"Creation Date","type":"date","default":0,"customizable":false},
    "favorite":{"name":"Favorite","type":"boolean","default":false,"private":true,"show_in_table":6,"icon":"http:\/\/example.com\/wp-content\/themes\/disciple-tools-theme\/dt-assets\/images\/star.svg"}
    //etc
  },
    
  "channels":{
    "email":{"name":"Email","icon":"http:\/\/example.com\/wp-content\/themes\/disciple-tools-theme\/dt-assets\/images\/email.svg?v=2","type":"communication_channel","tile":"details","customizable":false,"in_create_form":["access"],"label":"Email"},
    "address":{"name":"Address","icon":"http:\/\/example.com\/wp-content\/themes\/disciple-tools-theme\/dt-assets\/images\/house.svg?v=2","type":"communication_channel","tile":"details","mapbox":false,"customizable":false,"in_create_form":["access"],"label":"Address"},
    "twitter":{"name":"Twitter","icon":"http:\/\/example.com\/wp-content\/themes\/disciple-tools-theme\/dt-assets\/images\/twitter.svg?v=2","hide_domain":true,"type":"communication_channel","tile":"details","customizable":false,"label":"Twitter"}
    //etc
  },
  "connection_types":["relation","subassigned","subassigned_on","coaching","coached_by","baptized_by","baptized","people_groups","groups","group_leader","group_coach"],
  "label_singular":"Contact",
  "label_plural":"Contacts",
  "post_type":"contacts"
}
https://example.com/wp-json/dt-posts/v2/{post_type}/settings