Member Posts API - Create, Search, Update, Delete and Get
Link: https://support.brilliantdirectories.com/support/solutions/articles/12000093239
The API allows retrieving, creating, updating, searching and deleting member posts on the website. However, only one post can be updated at a time.
To enable automatic geocoding of the post's location and to search for a post by location, the Enable All Location Features for "Pretty URL" Search Results Pages (Additional Google Maps API Cost) setting must be configured in the site's Advanced Settings.
For detailed instructions, please refer to the guide here: Set Up Pretty URLs with Google Maps.
Available API Endpoints
Below is a complete list of API endpoints, organized by content type, which enable developers to retrieve, create, update, delete, or search various types of posts.
Single Image Post Endpoints
(Videos, Articles, Jobs, Events, Coupons, Audios, Discussions)
- https://example.com/api/v2/data_posts/get/{id}
- https://example.com/api/v2/data_posts/create
- https://example.com/api/v2/data_posts/update
- https://example.com/api/v2/data_posts/delete
- https://example.com/api/v2/data_posts/search
Multi-Photo Post Endpoints
(Photo Albums, Products, Digital Products, Properties, Classifieds)
- https://example.com/api/v2/users_portfolio_groups/get/{id}
- https://example.com/api/v2/users_portfolio_groups/create
- https://example.com/api/v2/users_portfolio_groups/update
- https://example.com/api/v2/users_portfolio_groups/delete
- https://example.com/api/v2/users_portfolio_groups/search
Single-Image Posts
Model Notes: For the data_type parameter, use "20" for post types that include images and "9" for videos.
Get a Single Image Post
Read the data of a Single Image Post based on the post_id.
Endpoint:
GET https://example.com/api/v2/data_posts/get/{id} curl -H "Authorization: YOUR_API_KEY" \ "https://example.com/api/v2/data_posts/get/{id}"
Example Request:
GET https://example.com/api/v2/data_posts/get?property=post_id&property_value=61
Query Parameters:
property | The property key (eg., post_id). |
property_value | The value associated with the property. |
Example Response:
{ "status": "success", "message": [ { "post_id": "61", "post_video": "https://youtu.be/JoRwXMLsVis?si=IwYJqscdqxhU3fRn", "post_title": "History of Yoga Full Film English", "post_caption": "", "post_content": "The history of yoga can be traced back over 5,000 years to northern India. The practice of yoga has evolved over time, and is now practiced by people around the world.", "post_filename": "videos/history-of-yoga-full-film-english", "post_image": "/uploads/news-pictures/1-los-angeles-blog-post-image-20250313100136.jpg", "post_live_date": "2025-01-21T11:25:53+00:00", "post_author": "leSamp Member 1", "user": { "user_id": "1", "first_name": "leSamp", "last_name": "Member 1", "email": "[email protected]", "company": "Sample Member Inc." }, "data_category": { "data_id": "13", "system_name": "video", "data_type": "9", "data_name": "Video", "h1": "Video Library", "profile_tab": "Videos", "data_filename": "videos" } } ], "total": "1", "current_page": 1, "total_pages": 1 }
Create a Single Image Post
Add a new Single Image Post to the database.
Parameter Notes: data_id, user_id, data_type are required.
Endpoint:
POST https://example.com/api/v2/data_posts/create
Example Request:
{ "post_title": "African Artwork", "post_status": "1", "data_id": "14", "auto_image_import": "1", "post_image": "https:\/\/images.pexels.com\/photos\/31113252\/pexels-photo-31113252\/free-photo-of-traditional-market-vendor-in-zaria-city-nigeria.jpeg", "post_content": "African artwork encompasses a vast and diverse range of artistic expressions, deeply rooted in cultural traditions, spiritual beliefs, and social structures, often featuring vibrant colors, symbolic imagery, and functional objects. ", "user_id": "5", "data_type": "20", }
Query Parameters:
post_id | The unique identifier assigned to the post by the system. |
post_title | The title of the post. |
post_content | The main content of the post. |
post_category | The category under which the post is classified. |
post_image | The file path of the image associated with the post. |
post_type | The type of post. 20 for images, 9 for videos |
data_type | The data type identifier for the post. |
post_tags | A list of tags associated with the post. |
post_status | Post status: '1' or 'true' for published, '0' or 'false' for unpublished. |
post_live_date | The date and time when the post was published. |
post_author | The name of the user who authored the post. |
user_id | The User ID. |
post_expire_date | The date and time when the post expires, if applicable. |
post_start_date | The date and time when the post becomes active. |
data_id | The unique identifier related to the post data type. |
sticky_post | Indicates whether the post is marked as sticky or featured. |
sticky_post_expiration_date | The expiration date for a sticky post. |
post_image | The URL of the post image. |
auto_image_import | Set value to "1" or "true" to import the image. |
Example Response:
{ "status": "success", "message": { "post_id": "67", "post_title": "African Artwork", "post_content": "African artwork encompasses a vast and diverse range of artistic expressions, deeply rooted in cultural traditions, spiritual beliefs, and social structures, often featuring vibrant colors, symbolic imagery, and functional objects.", "post_filename": "blog/african-artwork", "post_image": "/uploads/news-pictures/pphoto-67.jpeg", "data_type": "20", "post_status": "1", "post_live_date": "2025-03-13T15:40:23+00:00", "post_author": "Admin User - Blog Author", "post_token": "efe566c93f6f42c9a94007f5db6e2c2b", "user_id": "5", "data_id": "14", "image_imported": 2, "auto_image_import": "1", "list_service": false, "data_category": { "data_id": "14", "system_name": "website_blog_article", "data_type": "20", "data_name": "Website Blog Article", "data_filename": "blog", "form_name": "blog_article_fields", "data_active": "1" }, "user": { "user_id": "5", "first_name": "Admin User - ", "last_name": "Blog Author", "email": "[email protected]" } } }
Update a Single Image Post
Update a post record and its related data in the database.
Parameter Notes: data_id, data_type and post_id are required.
Endpoint:
PUT https://example.com/api/v2/data_posts/update
Example Request:
{ "post_title": "Street African Artwork ", "data_id": "14", "data_type": "20", "post_id": "67", }
Example Response:
{
"status": "success",
"message": {
"post_id": "67",
"post_title": "Street African Artwork",
"post_content": "African artwork encompasses a vast and diverse range of artistic expressions, deeply rooted in cultural traditions, spiritual beliefs, and social structures, often featuring vibrant colors, symbolic imagery, and functional objects.",
"post_image": "/uploads/news-pictures/pphoto-67.jpeg",
"post_live_date": "2025-03-13T15:40:23+00:00",
"post_author": "Admin User - Blog Author",
"user_id": "5",
"data_id": "14",
"data_type": "20"
},
"user": {
"user_id": "5",
"first_name": "Admin User -",
"last_name": "Blog Author",
"email": "[email protected]",
"city": "New York",
"state_code": "NY",
"country_code": "US"
}
}
Delete a Single Image Post
Delete a Single Image Post and their related data from the database.
Parameter Notes: post_id is required.
Endpoint:
DELETE https://example.com/api/v2/data_posts/delete
Example Request:
{ "data_id": "14", "data_type": "20", "post_id": "30", }
Example Response:
{ "status": "success", "message": "Single Image post deleted" }
Search a Single Image Post
Search Single Image Posts and their related data from the database.
Parameter Notes: post_id is required.
Endpoint:
POST https://example.com/api/v2/data_posts/search
Example Request:
{ "output_type": "array", "data_id": "14", "q": "african", "action": "search" }
Query Parameters:
q | Enter a keyword to search for in post data. |
category | Enter a category to search for in post data. |
daterange | Enter a category to search for in post data. (11/09/2024 - 11/09/2024) |
search_priority_flag | Set to 1 to first be ordered by the search priority defined in membership plan settings, and then by the Order Results By setting above. |
show_expire_post | Set to 1 to have expired prior to the time of the search or the searched date range will show in search results. |
post_type_cache_system | Set to 1 (recommended) to cache search results and load subsequent matching search results more quickly. Set to NO to always query the database for all searches. This cannot be enabled if Order Results By is set to Random. |
address | Enter the location to search for. EG Los Angeles, California, United States |
output_type | Enter the type of response to receive. Valid options html, array. |
limit | Enter the maximum number of posts results to return per page of results. |
category_order_by | Set the order the data would be displayed. |
page | Enter the page number of results to return. For example, enter 2 to return the second page of results. |
Example Response:
{ "status": "success", "message": [ { "post_id": "67", "post_title": "Street African Artwork", "post_content": "African artwork encompasses a vast and diverse range of artistic expressions, deeply rooted in cultural traditions, spiritual beliefs, and social structures, often featuring vibrant colors, symbolic imagery, and functional objects.", "post_filename": "blog/african-artwork", "post_image": "/uploads/news-pictures/pphoto-67.jpeg", "data_type": "20", "post_clicks": "0", "post_price": "0.00", "feed_id": "0", "blog_id": "0", "post_status": "1", "post_live_date": "2025-03-13T15:40:23+00:00", "post_author": "Admin User - Blog Author", "post_token": "efe566c93f6f42c9a94007f5db6e2c2b", "data_id": "14", "revision_timestamp": "2025-03-13T11:40:30+00:00", "recurring_type": "0", "sticky_post": "0", "sticky_post_expiration_date": "0000-00-00", "sticky": "0", "auto_image_import": "1", "list_service": false, "data_category": { "data_id": "14", "system_name": "website_blog_article", "data_type": "20", "data_name": "Website Blog Article" }, "user": { "user_id": "5", "first_name": "Admin User - ", "last_name": "Blog Author", "email": "[email protected]", "modtime": "2025-02-04 21:07:53", "subscription_id": "4", "filename": "united-states/new-york/things-to-do/admin-user-blog-author", "active": "2", "token": "7c9e6f8940d7af9cb5de76f08e88b317", "ref_code": "Manually Added", "signup_date": "20151229122636", "cookie": "7c9e6f8940d7af9cb5de76f08e88b317", "last_login": "20210629163036" } } ], "total_posts": "1", "total_pages": 1, "total_members": 0 }
Multi-Image Posts
Model Notes: For the data_type parameter use "4".
Get a Multi Image Post
Read the data of a Multi Image Post based on the group_id.
Endpoint:
GET https://example.com/api/v2/users_portfolio_groups/get/{id}
Example Request:
curl -H "Authorization: YOUR_API_KEY" \ "https://example.com/api/v2/users_portfolio_groups/get?property=group_id&property_value=8"
Query Parameters:
property | The property key (eg., group_id). |
property_value | The value associated with the property. |
Example Response:
{ "status": "success", "message": [ { "group_id": "8", "user_id": "1", "group_name": "Dog Treats", "group_desc": "<p>Dog treats are snacks, not meals, and are often used for training or as a reward, but should be given in moderation to avoid overfeeding and weight gain.</p>", "group_location": null, "group_date": null, "date_updated": "20250121110800", "group_order": "0", "group_token": "4178576fa1a349f595a38244a366db10", "group_filename": "photo-albums/dog-treats", "group_status": "1", "structure_id": "0", "facebook_id": "", "additional_fields": "", "group_type": "", "data_type": "4", "data_id": "10", "group_category": "Category 1", "post_tags": "reward, treats, best friend", "sticky_post": "0", "post_location": "", "sticky_post_expiration_date": "0000-00-00", "group_category": "Category 1", "data_category": { "data_id": "10", "system_name": "photo_album", "data_type": "4", "data_name": "Photo Album", "data_filename": "photo-albums", "form_name": "photo_album_fields", "search_results": "location", "category_tab": "Tab Name", "profile_tab": "Photo Albums", "category_sidebar": "Post Search Result", "profile_sidebar": "Post Single Page", "sidebar_search_module": "Bootstrap Theme - Module - Photo Albums Search", "category_order_by": "publish-desc", "feature_categories": "Category 1, Category 2, Category 3" }, "user": { "user_id": "1", "first_name": "leSamp", "last_name": "Member 1", "email": "[email protected]", "company": "Sample Member Inc.", "phone_number": "555-555-5555", "address1": "123 S Main St", "address2": "", "city": "Los Angeles", "zip_code": "90012", "state_code": "CA", "state_ln": "California", "country_code": "US", "country_ln": "United States Of America", "lat": "", "lon": "", "search_description": "" }, "users_portfolio": [ { "photo_id": "19", "user_id": "1", "file": "dc77bec33c55ffd33bf522d1aaaa0fe0.jpg", "title": "Bday Gift", "desc": "Surprise your best friend with these!", "group_id": "8", "photo_token": "7e9f29b85767abc593adca8c10730379", "photo_date_added": "20250121110816", "photo_date_updated": "20250313113916", "status": "1", "order": "1", "orgfile": "dc77bec33c55ffd33bf522d1aaaa0fe0.jpg" }, { "photo_id": "28", "user_id": "1", "file": "478c7b8d444928808c7ef59e7037ca2a.jpg", "title": "Training", "desc": "Use for Training", "group_id": "8", "photo_token": "ef4db8261d7a1043d52cda070ab64f04", "photo_date_added": "20250313113744", "photo_date_updated": "20250313113916", "status": "1", "order": "4", "orgfile": "478c7b8d444928808c7ef59e7037ca2a.jpg" } ] } ], "total": "1", "current_page": 1, "total_pages": 1 }
Create a Multi Image Post
Add a new Multi Image Post to the database.
Endpoint:
POST https://example.com/api/v2/users_portfolio_groups/create
Example Request:
{ "group_name": "FOOTPRINT01 Barefoot Speakers", "group_category": "Category 1", "group_status": "1", "group_location": "1710 NW Upshur St, Portland, OR 97209, United States", "auto_image_import": "1", "group_desc": "The Footprint01\u2122 is a active 3-way speaker that shares the same Barefoot signature designs \u2014 Dual-Force\u2122 technology opposing sub woofers, dual ring radiator tweeter and Multi-Emphasis Monitor Emulation\u2122 technology \u2014 as the MicroMain and MasterStack monitor lines. Footprint01 features dual opposing 8-inch paper cone subwoofers, a 4-inch aluminum cone midrange driver and a 1-inch dual ring radiating tweeter, components that all share a lineage with Barefoot\u2019s other products.", "data_type": "4", "user_id": "5", "post_image": "https:\/\/barefootsound.com\/wp-content\/uploads\/2024\/02\/barefoot_sound_footprint01_1-1.jpg,https:\/\/barefootsound.com\/wp-content\/uploads\/2024\/02\/barefoot_sound_footprint01_3.jpg", "post_tags": "Speaker,3way,hifi,mixing,mastering", "data_id": "6", "title": "Back Side Speaker", "description": " 8\u2033 Dual-Force\u2122 woofers", }
Query Parameters:
group_id | The ID of the multi-image post. |
user_id | The ID of the user. |
group_name | The Title of the post. |
group_desc | Description of the post. |
group_location | Location of the post. |
auto_geocode | The system will geocode the location with the Google Maps API integration. |
auto_image_import | Set value to "1" or "true" to import the image. |
post_image | URLs of images related to the review. Separate multiple URLs with commas. |
group_status | Post status: '1' or 'true' for published, '0' or 'false' for unpublished. |
data_type | Integer representing the type of data for the group. '4' for Multi-image posts. |
data_id | Identifier for the specific data related to the group. |
group_category | The category under which the group is classified. |
post_tags | Tags associated with the group for categorization and search. |
property_status | Status of the group property, such as available or not. |
property_type | Type of the property associated with the group. |
property_price | Price of the property related to the group. |
property_beds | Number of beds in the property associated with the group. |
property_baths | Number of bathrooms in the property related to the group. |
property_sqr_foot | Size of the property in square feet. |
sticky_post | Indicates whether the group is marked as sticky or featured. |
sticky_post_expiration_date | Expiration date for the sticky post, in 'YYYY-MM-DD HH:MM:SS' format. |
Example Response:
{ "status": "success", "message": { "group_id": "12", "user_id": "5", "group_name": "FOOTPRINT01 Barefoot Speakers", "group_desc": "The Footprint01™ is a active 3-way speaker that shares the same Barefoot signature designs — Dual-Force™ technology opposing sub woofers, dual ring radiator tweeter and Multi-Emphasis Monitor Emulation™ technology — as the MicroMain and MasterStack monitor lines. Footprint01 features dual opposing 8-inch paper cone subwoofers, a 4-inch aluminum cone midrange driver and a 1-inch dual ring radiating tweeter, components that all share a lineage with Barefoot’s other products.", "group_location": "1710 NW Upshur St, Portland, OR 97209, United States", "date_updated": null, "group_status": "1", "group_filename": "classifieds/footprint01-barefoot-speakers", "post_tags": "Speaker,3way,hifi,mixing,mastering", "post_image": "https://barefootsound.com/wp-content/uploads/2024/02/barefoot_sound_footprint01_1-1.jpg,https://barefootsound.com/wp-content/uploads/2024/02/barefoot_sound_footprint01_3.jpg", "title": "Front Side Speaker", "description": "650 watts of power per monitor", "data_category": { "data_id": "6", "system_name": "classified", "data_type": "4", "data_name": "Classified", "h1": "Classified Ads", "profile_tab": "Classifieds", "category_sidebar": "Post Search Result", "profile_sidebar": "Post Single Page", "sidebar_search_module": "Bootstrap Theme - Module - Classifieds Search", "category_order_by": "publish-desc", "feature_categories": "Category 1, Category 2, Category 3" }, "user": { "user_id": "5", "first_name": "Admin User - ", "last_name": "Blog Author", "email": "[email protected]", "city": "New York", "state_code": "NY", "state_ln": "New York", "country_code": "US", "country_ln": "United States", "modtime": "2025-02-04 21:07:53", "listing_type": "Company", "lat": "40.71278370", "lon": "-74.00594130", "parent_id": "0" }, "users_portfolio": { "photo_id": "29", "user_id": "5", "file": "aphoto-29.jpg", "photo_token": "a668668280e67ef8786be5d32a26ad65", "photo_date_added": "20250313181727", "status": "1", "order": "1", "image_imported": "2" } } }
Update a Multi-Image Post
Update an existing multi-image post in the database.
Parameter Notes: group_id and data_id are required.
Endpoint:
PUT https://example.com/api/v2/users_portfolio_groups/update
Example Request:
{ "group_name": "FOOTPRINT01 Barefoot Speakers - Producers", "group_category": "Category 1", "group_status": "1", "group_location": "1710 NW Upshur St, Portland, OR 97209, United States", "auto_image_import": "1", "group_desc": "The Footprint01\u2122 is a active 3-way speaker that shares the same Barefoot signature designs \u2014 Dual-Force\u2122 technology opposing sub woofers, dual ring radiator tweeter and Multi-Emphasis Monitor Emulation\u2122 technology \u2014 as the MicroMain and MasterStack monitor lines. Footprint01 features dual opposing 8-inch paper cone subwoofers, a 4-inch aluminum cone midrange driver and a 1-inch dual ring radiating tweeter, components that all share a lineage with Barefoot\u2019s other products.", "data_type": "4", "user_id": "5", "post_tags": "Speaker,3way,hifi,mixing,mastering", "data_id": "6", "group_id": "13", "bdapi_model": "users_portfolio_groups" }
Example Response:
{ "status": "success", "message": { "group_id": "13", "user_id": "5", "group_name": "FOOTPRINT01 Barefoot Speakers - Producers", "group_desc": "The Footprint01™ is an active 3-way speaker featuring Barefoot’s signature designs, including Dual-Force™ opposing subwoofers, a dual ring radiator tweeter, and Multi-Emphasis Monitor Emulation™ technology. It includes dual 8-inch subwoofers, a 4-inch aluminum midrange driver, and a 1-inch tweeter.", "group_location": "1710 NW Upshur St, Portland, OR 97209, United States", "group_filename": "classifieds/footprint01-barefoot-speakers-13", "group_status": "1", "post_tags": "Speaker,3way,hifi,mixing,mastering", "group_category": "Category 1", "revision_timestamp": "2025-03-13 14:22:09", "user": { "user_id": "5", "first_name": "Admin User", "last_name": "Blog Author", "email": "[email protected]", "city": "New York", "state_code": "NY", "country_code": "US", "lat": "40.71278370", "lon": "-74.00594130", "listing_type": "Company" }, "users_portfolio": [ { "photo_id": "30", "user_id": "5", "file": "aphoto-30.jpg", "group_id": "13", "photo_token": "9bf162853923593d295594e6908515fa", "photo_date_added": "2025-03-13 18:22:09", "status": "1" }, { "photo_id": "31", "user_id": "5", "file": "aphoto-31.jpg", "group_id": "13", "photo_token": "79a274a4d4d7f5b5b8dc85571167096d", "photo_date_added": "2025-03-13 18:22:09", "status": "1" } ] } }
Delete a Multi-Image Post
Delete a Multi Image Post and their related data from the database.
Parameter Notes: Use group_id to delete a Multi Image Post.
Endpoint:
DELETE https://example.com/api/v2/users_portfolio_groups/delete
Example Request:
{ "group_id": "13", }
Example Response:
{ "status": "success", "message": "Multi Image post deleted" }
Search for Multi-Image Posts
Search Multi Image Posts and their related data from the database.
Parameter Notes: Use data_id or filename.
Endpoint:
POST https://example.com/api/v2/users_portfolio_groups/search
Example Request:
{ "output_type": "array", "data_id": "6", "group_id": "12", "action": "search" }
Query Parameters:
q | Enter a keyword to search for in post data. |
category | Enter a category to search for in post data. |
property_status | Enter a status to search for in post data. |
bedrooms | Enter a bedroom to search for in post data. |
bathrooms | Enter a bathroom to search for in post data. |
price | Enter a price to search for in post data. |
search_results_photo_slider | Set to 1 to search results for this feature will have a carousel displaying the posts photos. |
enable_search_results_map | Set to 1 display a map icon at the top of search results pages. Clicking on this icon will display the search results as pins on a Google Map. |
search_priority_flag | Set to 1 to first be ordered by the search priority defined in membership plan settings, and then by the Order Results By setting above. |
show_expire_post | Set to 1 to have expired prior to the time of the search or the searched date range will show in search results. |
post_type_cache_system | Set to 1 (recommended) to cache search results and load subsequent matching search results more quickly. Set to NO to always query the database for all searches. This cannot be enabled if Order Results By is set to Random. |
address | Enter the location to search for. EG Los Angeles, California, United States |
output_type | Enter the type of response to receive. Valid options html, array. |
limit | Enter the maximum number of posts results to return per page of results. |
category_order_by | Set the order the data would be displayed. |
page | Enter the page number of results to return. For example, enter 2 to return the second page of results. |
Example Response:
{ "status": "success", "message": [ { "group_id": "12", "user_id": "5", "group_name": "FOOTPRINT01 Barefoot Speakers", "group_desc": "The Footprint01™ is a active 3-way speaker that shares the same Barefoot signature designs — Dual-Force™ technology opposing sub woofers, dual ring radiator tweeter and Multi-Emphasis Monitor Emulation™ technology — as the MicroMain and MasterStack monitor lines. Footprint01 features dual opposing 8-inch paper cone subwoofers, a 4-inch aluminum cone midrange driver and a 1-inch dual ring radiating tweeter, components that all share a lineage with Barefoot’s other products.", "group_location": "1710 NW Upshur St, Portland, OR 97209, United States", "group_token": "d9e9267d0aade74ee63eed30ea30170c", "group_filename": "classifieds/footprint01-barefoot-speakers", "group_status": "1", "data_type": "4", "data_id": "6", "group_category": "Category 1", "revision_timestamp": "2025-03-13 14:17:27", "post_tags": "Speaker,3way,hifi,mixing,mastering", "sticky_post": "0", "revision_count": "0", "sticky": "0", "users_portfolio": { "photo_id": "29", "user_id": "5", "file": "aphoto-29.jpg", "group_id": "12", "photo_token": "a668668280e67ef8786be5d32a26ad65", "photo_date_added": "20250313181727", "status": "1", "order": "1", "price": "0.00", "data_type": "4", "data_id": "6", "revision_timestamp": "2025-03-13 14:17:25", "image_imported": "2" } } ], "total_posts": "1", "total_pages": 1, "total_members": 0 }