API Reference - Post Types
Link: https://support.brilliantdirectories.com/support/solutions/articles/12000108054
← Back to API Reference | Getting Started
Post Types
Post types define the different categories of content that members can publish — listings, blog posts, events, jobs, products, and any custom type configured on your site. Each post type has its own form, display settings, and URL structure.
Model name in URL:
data_categories — DB table: data_categoriesThe Post Type Object
| Field | Type | Description |
|---|---|---|
data_id | integer | Unique post type ID (primary key, read-only) |
system_name | string | Unique system identifier for this post type |
data_name | string | Display name shown on the website required on create |
data_type | string | Data type classification |
form_name | string | Name of the form used to create/edit posts of this type |
data_filename | string | URL-friendly slug |
data_active | integer | 1 if active, 0 if disabled |
display_order | integer | Display order on the website category page |
profile_display_order | integer | Display order on member profiles |
per_page | integer | Default number of posts shown per page |
category_tab | string | Tab label on the category page |
profile_tab | string | Tab label on member profiles |
h1 | string | H1 heading text for the category page |
h2 | string | H2 heading text for the category page |
icon | string | Icon class for this post type |
post_type | string | Default post type label applied to new posts |
always_on | integer | 1 to always display this post type |
distance_search | integer | 1 to enable location/distance search for this type |
caption_length | integer | Max caption length (characters) in search results |
revision_timestamp | timestamp | Last modified timestamp (auto-updated) |
comments | text | Comments section HTML or configuration |
comments_header | string | Header text for the comments section |
comments_code | text | Custom code for the comments section (e.g. Disqus embed) |
search_results_div | text | Custom HTML wrapper for search results |
search_results | text | Custom search results template HTML |
footer_content | text | Footer content displayed below post listings |
search_results_layout | text | Layout template for category search results |
profile_results_layout | text | Layout template for profile-level results |
post_date | string | Default post date format or setting |
category_sidebar | string | Sidebar widget name for the category page (default: Default Sidebar) |
profile_sidebar | string | Sidebar widget name for the profile page (default: Default Single Sidebar) |
sidebar_search_module | string | Search module widget used in the sidebar |
category_order_by | string | Default sort order for category page listings |
profile_order_by | string | Default sort order for profile page listings |
profile_header | text | Custom header HTML for the profile post section |
profile_footer | text | Custom footer HTML for the profile post section |
category_sql | string | Custom SQL clause for category page queries |
profile_per_page | integer | Number of posts shown per page on member profiles (default: 1000) |
category_header | text | Custom header HTML for the category page |
category_footer | text | Custom footer HTML for the category page |
category_group | integer | Category group ID for organizing post types |
software_version | integer | Software version number for this post type configuration |
feature_categories | string | Comma-separated category IDs featured for this post type |
is_event_feature | integer | Whether this post type has event features enabled |
search_priority_flag | integer | Flag for search priority behavior |
type_of_feature | string | Feature type classification for this post type |
enable_price_slider | integer | Whether to enable a price slider filter in search |
is_digital_product | integer | Whether posts of this type represent digital products |
enable_map | integer | Whether to show a map on the detail page |
enable_search_results_map | integer | Whether to show a map on search results pages |
enable_global_search_results_post_setting | integer | Whether to include this post type in global search results |
keyword_search_filter | string | Keyword search filter configuration |
enableLazyLoad | integer | Whether lazy loading is enabled for search results |
post_approval | integer | Whether posts require admin approval before publishing |
photo_gallery_videos | integer | Whether video support is enabled in photo galleries |
search_results_photo_slider | integer | Whether to show a photo slider in search results |
search_results_start_view | string | Default view mode for search results (EG grid, list) |
delete_same_content | integer | Whether to prevent duplicate content submissions |
enable_recurring_events_addon | integer | Whether the recurring events addon is enabled for this type |
sidebar_position_mobile | string | Sidebar position on mobile devices |
allow_post_links | integer | Whether to allow external links in posts |
show_expire_post | integer | Whether to show post expiration dates |
review_admin_notification_email | string | Email template for admin review notifications |
review_member_notification_email | string | Email template for member review notifications |
review_submitter_notification_email | string | Email template for review submitter notifications |
review_approved_submitter_notification_email | string | Email template sent to submitter when review is approved |
review_member_pending_notification_email | string | Email template for pending review member notifications |
category_ignore_search_priority | integer | Whether to ignore search priority on category pages |
post_comment_settings | string | Comment settings configuration for this post type |
post_type_cache_system | integer | Cache system setting for this post type |
webhook_run_status | integer | Webhook execution status flag |
referral_credits | integer | Number of referral credits awarded for this post type |
List Post Types
GET /api/v2/data_categories/get
Copy
curl -X GET "https://www.yourdomain.com/api/v2/data_categories/get?property=data_active&property_value=1" \ -H "X-Api-Key: your-api-key-here"
Retrieve a Post Type
GET /api/v2/data_categories/get/{data_id}
Copy
curl -X GET "https://www.yourdomain.com/api/v2/data_categories/get/3" \ -H "X-Api-Key: your-api-key-here"
Create a Post Type
POST /api/v2/data_categories/create
Copy
curl -X POST "https://www.yourdomain.com/api/v2/data_categories/create" \ -H "X-Api-Key: your-api-key-here" \ -d "data_name=Projects" \ -d "data_active=1" \ -d "category_tab=Projects" \ -d "profile_tab=Projects"
Retrieve Custom Fields for a Post Type
POST /api/v2/data_categories/custom_fields
Returns the custom fields configured for a specific post type form.
Example Request
Copy
curl -X POST "https://www.yourdomain.com/api/v2/data_categories/custom_fields" \ -H "X-Api-Key: your-api-key-here" \ -d "data_id=3"
Update a Post Type
PUT /api/v2/data_categories/update
Copy
curl -X PUT "https://www.yourdomain.com/api/v2/data_categories/update" \ -H "X-Api-Key: your-api-key-here" \ -d "data_id=3" \ -d "category_tab=Our+Projects" \ -d "per_page=20"
Delete a Post Type
DELETE /api/v2/data_categories/delete
Copy
curl -X DELETE "https://www.yourdomain.com/api/v2/data_categories/delete" \ -H "X-Api-Key: your-api-key-here" \ -d "data_id=3"
