Brilliant Directories API Reference

Version 2.1 — Last updated April 2026

Getting Started

Getting Started Guide — Authentication, rate limiting, pagination, filtering, sorting, errors, and the fields endpoint.

Standard API Endpoints

Core API resources available to all API keys by default.

• Users user
• Users Clicked Link users_clicks
• Leads leads
• Single Image Posts data_posts
• Multi Image Posts users_portfolio_groups
• Album Photos users_portfolio
• Users Reviews users_reviews
• Post Types data_categories
• Unsubscribed unsubscribe_list
• Widgets data_widgets

Advanced API Endpoints

Extended API resources for advanced integrations. These endpoints require the Advanced API permission to be enabled on your API key.

Categories & Tags

• Categories (Professions) category
• Category Groups category_group
• Tags tags
• Tag Groups tag_groups
• Tag Types tag_types
• Tag Relationships rel_tags

Member Extensions

• User Metadata users_meta
• User Settings users_setting
• User Photos users_photo
• User Favorites users_favorite
• User Locations users_locations
• Service Areas service_areas
• Users Portfolio Tags users_portfolio_tags
• User Types user_types
• User Services rel_services
• User Invite Logs user_invite_log

Comments & Lead Matches

• Comments comments
• Lead Matches lead_matches

Forms & Submissions

• Forms form
• Form Fields form_fields
• Form Inquiries form_inquiries
• User Submitted Forms user_submitted_forms

Contacts & Communication

• Contacts contacts
• Contact Links contacts_bridge
• Messages messages
• Chat Messages chat_message_items
• Chat Threads chat_message_threads
• Notes notes

Email System

• Email Templates email_templates
• Email Campaigns email_schedule
• Email Automation Settings email_automation_settings
• Email Auto Logs email_auto_log
• Email Auto Sent email_auto_sent
• Email Lists email_list
• Email Logs email_log
• Email Outbox email_outbox
• Email Outbox Logs email_outbox_log

Subscriptions & Transactions

• Membership Plans subscription_types
• Post Transactions post_transactions
• Marketing Offers marketing_offers

Content Management

• Data Types data_types
• Data Flows data_flows
• Data Flow Actions data_flow_actions
• Widget Placements data_widgets_rel
• Sidebars sidebars
• Menus menus
• Menu Items menu_items
• Redirects redirect_301
• Smart Lists smart_lists

Website Configuration

• Website Labels website_labels
• Label Translations website_labels_translation
• Design Settings website_design_settings
• Website Contacts website_contacts
• Website Notifications website_notifications
• Image Settings image_settings

Reference & Lookup Tables

Read-only reference data used throughout the platform. While CRUD endpoints exist, these tables are typically accessed via GET operations only.

• Countries list_countries
• States list_states
• Services list_services
• Pages list_seo
• SEO Templates list_seo_template
• Location Cities location_cities
• Location States Mapping location_states
• Universal Search Cache universal_search_cache

Admin & System

Internal admin and system management resources. These endpoints are typically used for platform-level operations and integrations.

• Admin Roles admin_roles
• Admin Role Permissions admin_role_permissions
• Admin Role Plugin Permissions admin_role_plugins_permissions
• API Keys bd_api_keys
• Webhooks bd_webhooks
• Business Data Logs business_data_logs
• Business Data Tasks business_data_api_task
• Installer Groups installer_groups
• Installer Steps installer_steps
• Password Retrieval Sessions password_retrieval_sessions
• Plugin Records plugin_records

Activity & Logging

Append-only log tables that record platform activity. Typically accessed via GET operations only.

• Users Activity Log users_log