Brilliant Directories API Endpoints Technical Reference

Written by Chan Nier
Updated on February 19, 2025

Link: https://support.brilliantdirectories.com/support/solutions/articles/12000101842

The Brilliant Directories API provides a set of endpoints for interacting with and managing various aspects of a directory website. It supports API key authentication and offers operations for creating, reading, updating, and deleting data from the website. The API is designed to facilitate integrations and customizations by providing access to essential website functions through RESTful commands.

Authentication

Authenticate the API Key

Check if the API Key is valid

Users

Create, read, update, and delete users from the database

Read the data of a single user based on the user_id

Add a new user to the database

Update a user record and their related data from the database

Delete a user and their related data from the database

Search Users and their related data from the database

Read the user transactions based on the user_id or client_id

Leads

Create, read, update, match, and delete leads from the database

Read the data of a single lead based on the lead_id

Add a new lead to the database

Match batch of emails or ids into a specific lead

Update a Lead record and their related data from the database

Delete a lead and their related data from the database

Single Image Posts

Create, read, update, and delete single image posts from the database

Read the data of a Single Image Post based on the post_id

Add a new Single Image Post to the database

Update a Single Image Post record and their related data from the database

Delete a Single Image Post and their related data from the database

Multi Image Posts

Create, read, update, and delete multi image posts from the database

Read the data of a Multi Image Post based on the group_id

Add a new Multi Image Post to the database

Update a Multi Image Post record and their related data from the database

Delete a Multi Image Post and their related data from the database

Users Reviews

Create, read, update, and delete users reviews

Read the data of a Users Reviews based on the review_id

Add a new User Review to the database

Update a User Review record and their related data from the database

Delete a User Review and their related data from the database

Post Types

Create, read, update, and delete post types from the database

Read the data of a single post type based on the data_id

Add a post type to the database

Get all fields available for the post type

Update a post type record and their related data from the database

Delete a post type and their related data from the database

Unsubscribed

Create, read, update, and delete Unsubscribed email from the database

Read the data of a single Unsubscriber by id

Add a unsubcriber to the database

Update a unsubcribe list record and their related data from the database

Delete a post type and their related data from the database

Widgets

Create, read, update, render, and delete widgets from the database

Read the data of a single widget based on the widget_id

Add a new widget to the database

Update a widget record and their related data from the database

Delete a widget and their related data from the database

Render widget content of specific widget

For additional assistance:
Email support@brilliantdirectories.com or create a ticket Inside Your Account Dashboard.

Was this article helpful and accurate? Yes No

Brilliant Directories API Endpoints Technical Reference

Schemas