> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Brilliant Directories

The Brilliant Directories connector lets your AI agent act in each user's Brilliant Directories account. Each user connects their own Brilliant Directories API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 48 tools.

**Authentication:** API Key
**Categories:** CRM & Sales, Marketing
**Tools:** 48: 27 read, 14 write, 7 destructive
**Users sign in with:** API key
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=BRILLIANTDIRECTORIES)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Brilliant Directories connection

   In **AgentKit > Connections**, create a Brilliant Directories connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'brilliantdirectories'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Brilliant Directories:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'brilliantdirectories_album_photos_list',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "brilliantdirectories"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Brilliant Directories:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="brilliantdirectories_album_photos_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their Brilliant Directories credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'brilliantdirectories_album_get',
  toolInput: {
    group_id: '<group_id>',
  },
  connector: 'brilliantdirectories',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="brilliantdirectories_album_get",
    tool_input={
        "group_id": "<group_id>",
    },
    connection_name="brilliantdirectories",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `brilliantdirectories_album_get`

Get Album · Read-only

Get one multi-image post (album) by ID. Returns the record (in a one-item message array). Get IDs from brilliantdirectories_albums_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `group_id` (`string`, required): ID of the multi-image post (album). Example: 77.

Example input: `{"group_id":"<group_id>"}`

### `brilliantdirectories_album_photo_get`

Get Album Photo · Read-only

Get one album photo by ID. Returns the record (in a one-item message array). Get IDs from brilliantdirectories_album_photos_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `photo_id` (`string`, required): ID of the album photo. Example: 905.

Example input: `{"photo_id":"<photo_id>"}`

### `brilliantdirectories_album_photos_list`

List Album Photos · Read-only

List album photos on the directory site, 25 at a time with cursor paging, filtered by any field and sorted by any column. Returns a page of album photo records with total and next_page. Use brilliantdirectories_album_photo_get for one record.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): Records per page: 25 by default, up to 100. Example: 25.
- `order_column` (`string`, optional): Column to sort by, or a comma-separated list. Example: last_name.
- `order_type` (`string`, optional): Sort direction: ASC (default), DESC or RAND. Example: ASC. One of: `ASC`, `DESC`, `RAND`.
- `page` (`string`, optional): Cursor token from the previous response's next_page (or prev_page). Leave empty for the first page. Example: MipfKjI1.
- `property` (`string`, optional): Field name to filter on, for example active, email or signup_date. Example: active.
- `property_logic` (`string`, optional): Comparison operator: =, ne, gt, gte, lt, lte, like, in, contains, starts_with, since_days, between_dates and more. Defaults to =. Example: =.
- `property_value` (`string`, optional): Value to compare property with (not needed for is_null / is_not_null). Example: 2.

Example input: `{}`

### `brilliantdirectories_albums_list`

List Albums · Read-only

List multi-image post (album)s on the directory site, 25 at a time with cursor paging, filtered by any field and sorted by any column. Returns a page of multi-image post (album) records with total and next_page. Use brilliantdirectories_album_get for one record.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): Records per page: 25 by default, up to 100. Example: 25.
- `order_column` (`string`, optional): Column to sort by, or a comma-separated list. Example: last_name.
- `order_type` (`string`, optional): Sort direction: ASC (default), DESC or RAND. Example: ASC. One of: `ASC`, `DESC`, `RAND`.
- `page` (`string`, optional): Cursor token from the previous response's next_page (or prev_page). Leave empty for the first page. Example: MipfKjI1.
- `property` (`string`, optional): Field name to filter on, for example active, email or signup_date. Example: active.
- `property_logic` (`string`, optional): Comparison operator: =, ne, gt, gte, lt, lte, like, in, contains, starts_with, since_days, between_dates and more. Defaults to =. Example: =.
- `property_value` (`string`, optional): Value to compare property with (not needed for is_null / is_not_null). Example: 2.

Example input: `{}`

### `brilliantdirectories_api_key_verify`

Verify API Key · Read-only

Check that the API key is valid. Returns the website URL and the key's name. Use it as a connection test.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `brilliantdirectories_click_get`

Get Click · Read-only

Get one member link click by ID. Returns the record (in a one-item message array). Get IDs from brilliantdirectories_clicks_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `click_id` (`string`, required): ID of the member link click. Example: 9001.

Example input: `{"click_id":"<click_id>"}`

### `brilliantdirectories_clicks_list`

List Clicks · Read-only

List member link clicks on the directory site, 25 at a time with cursor paging, filtered by any field and sorted by any column. Returns a page of member link click records with total and next_page. Use brilliantdirectories_click_get for one record. Clicks record visitors clicking a member's links (website, phone, social).

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): Records per page: 25 by default, up to 100. Example: 25.
- `order_column` (`string`, optional): Column to sort by, or a comma-separated list. Example: last_name.
- `order_type` (`string`, optional): Sort direction: ASC (default), DESC or RAND. Example: ASC. One of: `ASC`, `DESC`, `RAND`.
- `page` (`string`, optional): Cursor token from the previous response's next_page (or prev_page). Leave empty for the first page. Example: MipfKjI1.
- `property` (`string`, optional): Field name to filter on, for example active, email or signup_date. Example: active.
- `property_logic` (`string`, optional): Comparison operator: =, ne, gt, gte, lt, lte, like, in, contains, starts_with, since_days, between_dates and more. Defaults to =. Example: =.
- `property_value` (`string`, optional): Value to compare property with (not needed for is_null / is_not_null). Example: 2.

Example input: `{}`

### `brilliantdirectories_lead_get`

Get Lead · Read-only

Get one lead by ID. Returns the record (in a one-item message array). Get IDs from brilliantdirectories_leads_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `lead_id` (`string`, required): ID of the lead. Example: 201.

Example input: `{"lead_id":"<lead_id>"}`

### `brilliantdirectories_leads_list`

List Leads · Read-only

List leads on the directory site, 25 at a time with cursor paging, filtered by any field and sorted by any column. Returns a page of lead records with total and next_page. Use brilliantdirectories_lead_get for one record.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): Records per page: 25 by default, up to 100. Example: 25.
- `order_column` (`string`, optional): Column to sort by, or a comma-separated list. Example: last_name.
- `order_type` (`string`, optional): Sort direction: ASC (default), DESC or RAND. Example: ASC. One of: `ASC`, `DESC`, `RAND`.
- `page` (`string`, optional): Cursor token from the previous response's next_page (or prev_page). Leave empty for the first page. Example: MipfKjI1.
- `property` (`string`, optional): Field name to filter on, for example active, email or signup_date. Example: active.
- `property_logic` (`string`, optional): Comparison operator: =, ne, gt, gte, lt, lte, like, in, contains, starts_with, since_days, between_dates and more. Defaults to =. Example: =.
- `property_value` (`string`, optional): Value to compare property with (not needed for is_null / is_not_null). Example: 2.

Example input: `{}`

### `brilliantdirectories_member_categories_get`

Get Member Categories · Read-only

Get the categories (professions and sub-categories) a member is listed under. Returns the member's category assignments.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `user_id` (`string`, required): ID of the member. Example: 42.

Example input: `{"user_id":"<user_id>"}`

### `brilliantdirectories_member_get`

Get Member · Read-only

Get one member by ID. Returns the record (in a one-item message array). Get IDs from brilliantdirectories_members_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `user_id` (`string`, required): ID of the member. Example: 42.

Example input: `{"user_id":"<user_id>"}`

### `brilliantdirectories_member_subscriptions_list`

List Member Subscriptions · Read-only

List a member's billing subscriptions, current and ended, each with its invoices. Returns subscriptions with plan, amount, cycle, next due date and status.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `client_id` (`integer`, optional): The member's billing client ID, instead of user_id. Example: 7429.
- `status` (`string`, optional): active for active subscriptions only, ended for cancelled ones; empty for all. Example: active. One of: `active`, `ended`.
- `user_id` (`integer`, optional): Member ID. Send user_id or client_id. Example: 42.

Example input: `{}`

### `brilliantdirectories_member_transactions_list`

List Member Transactions · Read-only

List every billing invoice of a member, each with the subscription it belongs to. Returns invoices with dates, totals, status and items. Use brilliantdirectories_member_subscriptions_list for subscriptions.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `client_id` (`integer`, optional): The member's billing client ID, instead of user_id. Example: 7429.
- `user_id` (`integer`, optional): Member ID. Send user_id or client_id. Example: 42.

Example input: `{}`

### `brilliantdirectories_members_list`

List Members · Read-only

List members on the directory site, 25 at a time with cursor paging, filtered by any field and sorted by any column. Returns a page of member records with total and next_page. Use brilliantdirectories_member_get for one record.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `include_labels` (`string`, optional): 1 also returns the labels of dropdown, checkbox and radio fields as <field>_values_stringify. Example: 1.
- `limit` (`integer`, optional): Records per page: 25 by default, up to 100. Example: 25.
- `order_column` (`string`, optional): Column to sort by, or a comma-separated list. Example: last_name.
- `order_type` (`string`, optional): Sort direction: ASC (default), DESC or RAND. Example: ASC. One of: `ASC`, `DESC`, `RAND`.
- `page` (`string`, optional): Cursor token from the previous response's next_page (or prev_page). Leave empty for the first page. Example: MipfKjI1.
- `property` (`string`, optional): Field name to filter on, for example active, email or signup_date. Example: active.
- `property_logic` (`string`, optional): Comparison operator: =, ne, gt, gte, lt, lte, like, in, contains, starts_with, since_days, between_dates and more. Defaults to =. Example: =.
- `property_value` (`string`, optional): Value to compare property with (not needed for is_null / is_not_null). Example: 2.

Example input: `{}`

### `brilliantdirectories_members_search`

Search Members · Read-only

Search the member directory like the site's front-end search, by keyword, category and location, with sorting. Returns matching members. Use brilliantdirectories_members_list to filter by exact field values.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `address` (`string`, optional): Location to search near, for example Los Angeles, CA. Example: Los Angeles, CA.
- `limit` (`integer`, optional): Results per page. Example: 25.
- `page` (`integer`, optional): Page number. Example: 1.
- `pid` (`integer`, optional): Top-level category ID. Example: 12.
- `q` (`string`, optional): Keyword to search across member data. Example: plumber.
- `sort` (`string`, optional): Sort order. Example: reviews. One of: `reviews`, `name ASC`, `name DESC`, `last_name_asc`, `last_name_desc`.
- `tid` (`integer`, optional): Sub-category ID. Example: 34.
- `ttid` (`integer`, optional): Sub-sub-category ID. Example: 56.

Example input: `{}`

### `brilliantdirectories_post_get`

Get Post · Read-only

Get one single image post by ID. Returns the record (in a one-item message array). Get IDs from brilliantdirectories_posts_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `post_id` (`string`, required): ID of the single image post. Example: 310.

Example input: `{"post_id":"<post_id>"}`

### `brilliantdirectories_post_type_get`

Get Post Type · Read-only

Get one post type by ID. Returns the record (in a one-item message array). Get IDs from brilliantdirectories_post_types_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `data_id` (`string`, required): ID of the post type. Example: 3.

Example input: `{"data_id":"<data_id>"}`

### `brilliantdirectories_post_types_list`

List Post Types · Read-only

List post types on the directory site, 25 at a time with cursor paging, filtered by any field and sorted by any column. Returns a page of post type records with total and next_page. Use brilliantdirectories_post_type_get for one record. Post types define the kinds of posts members can publish (articles, events, jobs, properties...).

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): Records per page: 25 by default, up to 100. Example: 25.
- `order_column` (`string`, optional): Column to sort by, or a comma-separated list. Example: last_name.
- `order_type` (`string`, optional): Sort direction: ASC (default), DESC or RAND. Example: ASC. One of: `ASC`, `DESC`, `RAND`.
- `page` (`string`, optional): Cursor token from the previous response's next_page (or prev_page). Leave empty for the first page. Example: MipfKjI1.
- `property` (`string`, optional): Field name to filter on, for example active, email or signup_date. Example: active.
- `property_logic` (`string`, optional): Comparison operator: =, ne, gt, gte, lt, lte, like, in, contains, starts_with, since_days, between_dates and more. Defaults to =. Example: =.
- `property_value` (`string`, optional): Value to compare property with (not needed for is_null / is_not_null). Example: 2.

Example input: `{}`

### `brilliantdirectories_posts_list`

List Posts · Read-only

List single image posts on the directory site, 25 at a time with cursor paging, filtered by any field and sorted by any column. Returns a page of single image post records with total and next_page. Use brilliantdirectories_post_get for one record.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): Records per page: 25 by default, up to 100. Example: 25.
- `order_column` (`string`, optional): Column to sort by, or a comma-separated list. Example: last_name.
- `order_type` (`string`, optional): Sort direction: ASC (default), DESC or RAND. Example: ASC. One of: `ASC`, `DESC`, `RAND`.
- `page` (`string`, optional): Cursor token from the previous response's next_page (or prev_page). Leave empty for the first page. Example: MipfKjI1.
- `property` (`string`, optional): Field name to filter on, for example active, email or signup_date. Example: active.
- `property_logic` (`string`, optional): Comparison operator: =, ne, gt, gte, lt, lte, like, in, contains, starts_with, since_days, between_dates and more. Defaults to =. Example: =.
- `property_value` (`string`, optional): Value to compare property with (not needed for is_null / is_not_null). Example: 2.

Example input: `{}`

### `brilliantdirectories_posts_search`

Search Posts · Read-only

Search single image posts by keyword, category, post type or member, like the site's front-end search. Returns matching posts. Pass data_id to scope the search to one post type (strongly recommended).

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `category` (`string`, optional): Category to filter by. Example: Renovation.
- `data_id` (`integer`, optional): Post type ID. Get IDs from brilliantdirectories_post_types_list. Example: 3.
- `limit` (`integer`, optional): Results per page. Example: 25.
- `page` (`integer`, optional): Page number. Example: 1.
- `q` (`string`, optional): Keyword to search across post data. Example: renovation.
- `user_id` (`integer`, optional): Only posts by this member. Example: 42.

Example input: `{}`

### `brilliantdirectories_review_get`

Get Review · Read-only

Get one member review by ID. Returns the record (in a one-item message array). Get IDs from brilliantdirectories_reviews_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `review_id` (`string`, required): ID of the member review. Example: 61.

Example input: `{"review_id":"<review_id>"}`

### `brilliantdirectories_reviews_list`

List Reviews · Read-only

List member reviews on the directory site, 25 at a time with cursor paging, filtered by any field and sorted by any column. Returns a page of member review records with total and next_page. Use brilliantdirectories_review_get for one record.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): Records per page: 25 by default, up to 100. Example: 25.
- `order_column` (`string`, optional): Column to sort by, or a comma-separated list. Example: last_name.
- `order_type` (`string`, optional): Sort direction: ASC (default), DESC or RAND. Example: ASC. One of: `ASC`, `DESC`, `RAND`.
- `page` (`string`, optional): Cursor token from the previous response's next_page (or prev_page). Leave empty for the first page. Example: MipfKjI1.
- `property` (`string`, optional): Field name to filter on, for example active, email or signup_date. Example: active.
- `property_logic` (`string`, optional): Comparison operator: =, ne, gt, gte, lt, lte, like, in, contains, starts_with, since_days, between_dates and more. Defaults to =. Example: =.
- `property_value` (`string`, optional): Value to compare property with (not needed for is_null / is_not_null). Example: 2.

Example input: `{}`

### `brilliantdirectories_unsubscribe_get`

Get Unsubscribe · Read-only

Get one unsubscribed email by ID. Returns the record (in a one-item message array). Get IDs from brilliantdirectories_unsubscribes_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `record_id` (`string`, required): ID of the unsubscribed email. Example: 15.

Example input: `{"record_id":"<record_id>"}`

### `brilliantdirectories_unsubscribes_list`

List Unsubscribes · Read-only

List unsubscribed emails on the directory site, 25 at a time with cursor paging, filtered by any field and sorted by any column. Returns a page of unsubscribed email records with total and next_page. Use brilliantdirectories_unsubscribe_get for one record.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): Records per page: 25 by default, up to 100. Example: 25.
- `order_column` (`string`, optional): Column to sort by, or a comma-separated list. Example: last_name.
- `order_type` (`string`, optional): Sort direction: ASC (default), DESC or RAND. Example: ASC. One of: `ASC`, `DESC`, `RAND`.
- `page` (`string`, optional): Cursor token from the previous response's next_page (or prev_page). Leave empty for the first page. Example: MipfKjI1.
- `property` (`string`, optional): Field name to filter on, for example active, email or signup_date. Example: active.
- `property_logic` (`string`, optional): Comparison operator: =, ne, gt, gte, lt, lte, like, in, contains, starts_with, since_days, between_dates and more. Defaults to =. Example: =.
- `property_value` (`string`, optional): Value to compare property with (not needed for is_null / is_not_null). Example: 2.

Example input: `{}`

### `brilliantdirectories_widget_get`

Get Widget · Read-only

Get one widget by ID. Returns the record (in a one-item message array). Get IDs from brilliantdirectories_widgets_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `widget_id` (`string`, required): ID of the widget. Example: 500.

Example input: `{"widget_id":"<widget_id>"}`

### `brilliantdirectories_widget_render`

Render Widget · Read-only

Render a widget and return its HTML output with template variables processed, for previews or embedding. Returns the widget name and output HTML.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `widget_id` (`integer`, required): ID of the widget to render. Get IDs from brilliantdirectories_widgets_list. Example: 500.

Example input: `{"widget_id":500}`

### `brilliantdirectories_widgets_list`

List Widgets · Read-only

List widgets on the directory site, 25 at a time with cursor paging, filtered by any field and sorted by any column. Returns a page of widget records with total and next_page. Use brilliantdirectories_widget_get for one record.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): Records per page: 25 by default, up to 100. Example: 25.
- `order_column` (`string`, optional): Column to sort by, or a comma-separated list. Example: last_name.
- `order_type` (`string`, optional): Sort direction: ASC (default), DESC or RAND. Example: ASC. One of: `ASC`, `DESC`, `RAND`.
- `page` (`string`, optional): Cursor token from the previous response's next_page (or prev_page). Leave empty for the first page. Example: MipfKjI1.
- `property` (`string`, optional): Field name to filter on, for example active, email or signup_date. Example: active.
- `property_logic` (`string`, optional): Comparison operator: =, ne, gt, gte, lt, lte, like, in, contains, starts_with, since_days, between_dates and more. Defaults to =. Example: =.
- `property_value` (`string`, optional): Value to compare property with (not needed for is_null / is_not_null). Example: 2.

Example input: `{}`

### `brilliantdirectories_album_create`

Create Album · Write

Create a multi-image post (album) with the given fields. Returns the new record with its group_id.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `data_id` (`integer`, required): Post type ID. Get IDs from brilliantdirectories_post_types_list. Example: 3.
- `data_type` (`integer`, required): Data type ID of the post type, required on create. Get it from the post type's data_type in brilliantdirectories_post_types_list. Example: 4.
- `group_name` (`string`, required): Album name/title. Example: Kitchen Projects.
- `user_id` (`integer`, required): ID of the member. Get IDs from brilliantdirectories_members_list. Example: 42.
- `group_category` (`string`, optional): Category classification. Example: Renovation.
- `group_desc` (`string`, optional): Album description or content. Example: Recent kitchen remodels.
- `group_location` (`string`, optional): Location associated with this album. Example: Los Angeles, CA.
- `group_status` (`integer`, optional): 0 =Hidden, 1 =Published. Example: 1.
- `post_tags` (`string`, optional): Comma-separated tags. Example: kitchen,remodel.

Example input: `{"data_id":3,"data_type":4,"group_name":"<group_name>","user_id":42}`

### `brilliantdirectories_album_photo_create`

Create Album Photo · Write

Create a album photo with the given fields. Returns the new record with its photo_id.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `group_id` (`integer`, required): Album group this photo belongs to required on create. Example: 77.
- `original_image_url` (`string`, required): URL of the image to import into the album, for example https://www.example.com/images/kitchen-1.jpg. Example: https://www.example.com/images/kitchen-1.jpg.
- `user_id` (`integer`, required): ID of the member. Get IDs from brilliantdirectories_members_list. Example: 42.
- `desc` (`string`, optional): Photo description. Example: White shaker cabinets with quartz counters.
- `keywords` (`string`, optional): Keywords or tags for the photo. Example: kitchen,cabinets.
- `link` (`string`, optional): URL associated with this photo. Example: https://www.example.com/projects/kitchen.
- `order` (`integer`, optional): Display order within the album. Example: 1.
- `status` (`integer`, optional): 0 =Hidden, 1 =Active. Example: 1.
- `title` (`string`, optional): Photo title or caption. Example: Finished kitchen.

Example input: `{"group_id":77,"original_image_url":"<original_image_url>","user_id":42}`

### `brilliantdirectories_album_photo_update`

Update Album Photo · Write

Update a album photo: send its photo_id and only the fields to change (empty values are ignored). Returns the updated record. Get IDs from brilliantdirectories_album_photos_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `photo_id` (`integer`, required): ID of the album photo to update. Example: 905.
- `desc` (`string`, optional): Photo description. Example: White shaker cabinets with quartz counters.
- `group_id` (`integer`, optional): Album group this photo belongs to required on create. Example: 77.
- `keywords` (`string`, optional): Keywords or tags for the photo. Example: kitchen,cabinets.
- `link` (`string`, optional): URL associated with this photo. Example: https://www.example.com/projects/kitchen.
- `order` (`integer`, optional): Display order within the album. Example: 1.
- `original_image_url` (`string`, optional): URL of the image to import into the album, for example https://www.example.com/images/kitchen-1.jpg. Example: https://www.example.com/images/kitchen-1.jpg.
- `status` (`integer`, optional): 0 =Hidden, 1 =Active. Example: 1.
- `title` (`string`, optional): Photo title or caption. Example: Finished kitchen.
- `user_id` (`integer`, optional): ID of the member. Get IDs from brilliantdirectories_members_list. Example: 42.

Example input: `{"photo_id":905}`

### `brilliantdirectories_album_update`

Update Album · Write

Update a multi-image post (album): send its group_id and only the fields to change (empty values are ignored). Returns the updated record. Get IDs from brilliantdirectories_albums_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `group_id` (`integer`, required): ID of the multi-image post (album) to update. Example: 77.
- `data_id` (`integer`, optional): Post type ID. Get IDs from brilliantdirectories_post_types_list. Example: 3.
- `data_type` (`integer`, optional): Data type ID of the post type, required on create. Get it from the post type's data_type in brilliantdirectories_post_types_list. Example: 4.
- `group_category` (`string`, optional): Category classification. Example: Renovation.
- `group_desc` (`string`, optional): Album description or content. Example: Recent kitchen remodels.
- `group_location` (`string`, optional): Location associated with this album. Example: Los Angeles, CA.
- `group_name` (`string`, optional): Album name/title. Example: Kitchen Projects.
- `group_status` (`integer`, optional): 0 =Hidden, 1 =Published. Example: 1.
- `post_tags` (`string`, optional): Comma-separated tags. Example: kitchen,remodel.
- `user_id` (`integer`, optional): ID of the member. Get IDs from brilliantdirectories_members_list. Example: 42.

Example input: `{"group_id":77}`

### `brilliantdirectories_lead_create`

Create Lead · Write

Create a lead with the given fields. Returns the new record with its lead_id.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `lead_email` (`string`, required): Email address of the lead submitter. Example: bob@example.com.
- `lead_name` (`string`, required): Contact name of the lead submitter. Example: Bob Johnson.
- `lead_location` (`string`, optional): Formatted location address for this lead. Example: Chicago, IL.
- `lead_message` (`string`, optional): Full message/description of the lead request. Example: I need a plumber for a leak.
- `lead_notes` (`string`, optional): Internal notes about this lead. Example: Resolved by member #42.
- `lead_phone` (`string`, optional): Phone number of the lead submitter. Example: 555-123-4567.
- `lead_price` (`number`, optional): Price associated with this lead. Example: 15.00.
- `status` (`string`, optional): Lead status. Example: 1.
- `sub_id` (`integer`, optional): Sub-category ID for matching. Example: 34.
- `top_id` (`integer`, optional): Top-level category ID for matching. Example: 12.

Example input: `{"lead_email":"<lead_email>","lead_name":"<lead_name>"}`

### `brilliantdirectories_lead_match`

Match Lead to Members · Write

Run the lead-matching algorithm for a lead: find members whose category, location and service area match and email them the lead. Returns how many members were matched. Create the lead first with brilliantdirectories_lead_create.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `lead_id` (`integer`, required): ID of the lead to match. Example: 201.

Example input: `{"lead_id":201}`

### `brilliantdirectories_lead_update`

Update Lead · Write

Update a lead: send its lead_id and only the fields to change (empty values are ignored). Returns the updated record. Get IDs from brilliantdirectories_leads_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `lead_id` (`integer`, required): ID of the lead to update. Example: 201.
- `lead_email` (`string`, optional): Email address of the lead submitter. Example: bob@example.com.
- `lead_location` (`string`, optional): Formatted location address for this lead. Example: Chicago, IL.
- `lead_message` (`string`, optional): Full message/description of the lead request. Example: I need a plumber for a leak.
- `lead_name` (`string`, optional): Contact name of the lead submitter. Example: Bob Johnson.
- `lead_notes` (`string`, optional): Internal notes about this lead. Example: Resolved by member #42.
- `lead_phone` (`string`, optional): Phone number of the lead submitter. Example: 555-123-4567.
- `lead_price` (`number`, optional): Price associated with this lead. Example: 15.00.
- `status` (`string`, optional): Lead status. Example: 1.
- `sub_id` (`integer`, optional): Sub-category ID for matching. Example: 34.
- `top_id` (`integer`, optional): Top-level category ID for matching. Example: 12.

Example input: `{"lead_id":201}`

### `brilliantdirectories_member_create`

Create Member · Write

Create a member with the given fields. Returns the new record with its user_id.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `email` (`string`, required): Email address — must be unique across the site required on create. Example: jane@example.com.
- `password` (`string`, required): Password (plain text on create/update; stored as a hash). Write-only — never returned in any API response required on create. Example: SecurePass123!.
- `subscription_id` (`integer`, required): Membership level ID required on create. Example: 1.
- `about_me` (`string`, optional): About Me biography (HTML allowed). Example: Licensed plumber with 15 years of experience.
- `active` (`integer`, optional): Account status: 1 =Inactive, 2 =Active, 3 =Cancelled, 4 =On Hold, 5 =Past Due. Example: 2.
- `address1` (`string`, optional): Street address line 1. Example: 100 Main St.
- `address2` (`string`, optional): Street address line 2. Example: Suite 4.
- `billing_cycle` (`string`, optional): Renewal interval, sent together with subscription_start_date. Example: annually. One of: `monthly`, `quarterly`, `semiannually`, `annually`, `biennially`, `triennially`.
- `city` (`string`, optional): City. Example: Los Angeles.
- `company` (`string`, optional): Business or company name. Example: Acme Plumbing.
- `country_code` (`string`, optional): 2-letter country code (e.g. US ). Example: US.
- `featured` (`integer`, optional): 1 if user is featured, 0 otherwise. Example: 1.
- `first_name` (`string`, optional): User's first name. Example: Jane.
- `last_name` (`string`, optional): User's last name. Example: Smith.
- `phone_number` (`string`, optional): Phone number. Example: 555-555-1234.
- `profession_id` (`integer`, optional): Industry/profession category ID. Example: 12.
- `state_code` (`string`, optional): 2-letter state/province code (e.g. CA ). Example: CA.
- `subscription_start_date` (`string`, optional): Start date of an already-running paid subscription (YYYY-MM-DD); send together with billing_cycle. Example: 2026-01-15.
- `website` (`string`, optional): User's website URL. Example: https://www.acmeplumbing.com.
- `zip_code` (`string`, optional): ZIP or postal code. Example: 90001.

Example input: `{"email":"<email>","password":"<password>","subscription_id":1}`

### `brilliantdirectories_member_update`

Update Member · Write

Update a member: send its user_id and only the fields to change (empty values are ignored). Returns the updated record. Get IDs from brilliantdirectories_members_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `user_id` (`integer`, required): ID of the member to update. Example: 42.
- `about_me` (`string`, optional): About Me biography (HTML allowed). Example: Licensed plumber with 15 years of experience.
- `active` (`integer`, optional): Account status: 1 =Inactive, 2 =Active, 3 =Cancelled, 4 =On Hold, 5 =Past Due. Example: 2.
- `address1` (`string`, optional): Street address line 1. Example: 100 Main St.
- `address2` (`string`, optional): Street address line 2. Example: Suite 4.
- `city` (`string`, optional): City. Example: Los Angeles.
- `company` (`string`, optional): Business or company name. Example: Acme Plumbing.
- `country_code` (`string`, optional): 2-letter country code (e.g. US ). Example: US.
- `email` (`string`, optional): Email address — must be unique across the site required on create. Example: jane@example.com.
- `featured` (`integer`, optional): 1 if user is featured, 0 otherwise. Example: 1.
- `first_name` (`string`, optional): User's first name. Example: Jane.
- `last_name` (`string`, optional): User's last name. Example: Smith.
- `password` (`string`, optional): Password (plain text on create/update; stored as a hash). Write-only — never returned in any API response required on create. Example: SecurePass123!.
- `phone_number` (`string`, optional): Phone number. Example: 555-555-1234.
- `profession_id` (`integer`, optional): Industry/profession category ID. Example: 12.
- `state_code` (`string`, optional): 2-letter state/province code (e.g. CA ). Example: CA.
- `subscription_id` (`integer`, optional): Membership level ID required on create. Example: 1.
- `website` (`string`, optional): User's website URL. Example: https://www.acmeplumbing.com.
- `zip_code` (`string`, optional): ZIP or postal code. Example: 90001.

Example input: `{"user_id":42}`

### `brilliantdirectories_post_create`

Create Post · Write

Create a single image post with the given fields. Returns the new record with its post_id.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `data_id` (`integer`, required): Post type ID. Get IDs from brilliantdirectories_post_types_list. Example: 3.
- `data_type` (`integer`, required): Data type ID of the post type, required on create. Get it from the post type's data_type in brilliantdirectories_post_types_list. Example: 4.
- `post_title` (`string`, required): Post title/headline. Example: Spring Renovation Special.
- `user_id` (`integer`, required): ID of the member. Get IDs from brilliantdirectories_members_list. Example: 42.
- `post_caption` (`string`, optional): Short caption or excerpt. Example: 20% off kitchen remodels.
- `post_category` (`string`, optional): Category name for this post. Example: Renovation.
- `post_content` (`string`, optional): Full post content (HTML allowed). Example: Book your kitchen remodel this spring and save 20%.
.
- `post_expire_date` (`string`, optional): Date post expires. Example: 20260601000000.
- `post_image` (`string`, optional): Main image filename. Example: https://www.example.com/images/kitchen.jpg.
- `post_live_date` (`string`, optional): Date post goes live (format: YYYYMMDDHHmmss ). When left out on create, it defaults to the current time in the website's time zone (the Website Time Zone setting under Settings » General Settings » Localization), and a supplied value is stored as sent. Responses return it in ISO 8601 with the website's UTC offset for that date, EG 2026-11-09T13:07:03-08:00 on a website set to Pacific Time. Example: 20260301000000.
- `post_location` (`string`, optional): Location or address. Example: Los Angeles, CA.
- `post_price` (`number`, optional): Price (for products or services). Example: 99.
- `post_status` (`integer`, optional): 0 =Draft, 1 =Published. Example: 1.
- `post_tags` (`string`, optional): Comma-separated tags. Example: kitchen,remodel.

Example input: `{"data_id":3,"data_type":4,"post_title":"<post_title>","user_id":42}`

### `brilliantdirectories_post_update`

Update Post · Write

Update a single image post: send its post_id and only the fields to change (empty values are ignored). Returns the updated record. Get IDs from brilliantdirectories_posts_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `post_id` (`integer`, required): ID of the single image post to update. Example: 310.
- `data_id` (`integer`, optional): Post type ID. Get IDs from brilliantdirectories_post_types_list. Example: 3.
- `data_type` (`integer`, optional): Data type ID of the post type, required on create. Get it from the post type's data_type in brilliantdirectories_post_types_list. Example: 4.
- `post_caption` (`string`, optional): Short caption or excerpt. Example: 20% off kitchen remodels.
- `post_category` (`string`, optional): Category name for this post. Example: Renovation.
- `post_content` (`string`, optional): Full post content (HTML allowed). Example: Book your kitchen remodel this spring and save 20%.
.
- `post_expire_date` (`string`, optional): Date post expires. Example: 20260601000000.
- `post_image` (`string`, optional): Main image filename. Example: https://www.example.com/images/kitchen.jpg.
- `post_live_date` (`string`, optional): Date post goes live (format: YYYYMMDDHHmmss ). When left out on create, it defaults to the current time in the website's time zone (the Website Time Zone setting under Settings » General Settings » Localization), and a supplied value is stored as sent. Responses return it in ISO 8601 with the website's UTC offset for that date, EG 2026-11-09T13:07:03-08:00 on a website set to Pacific Time. Example: 20260301000000.
- `post_location` (`string`, optional): Location or address. Example: Los Angeles, CA.
- `post_price` (`number`, optional): Price (for products or services). Example: 99.
- `post_status` (`integer`, optional): 0 =Draft, 1 =Published. Example: 1.
- `post_tags` (`string`, optional): Comma-separated tags. Example: kitchen,remodel.
- `post_title` (`string`, optional): Post title/headline. Example: Spring Renovation Special.
- `user_id` (`integer`, optional): ID of the member. Get IDs from brilliantdirectories_members_list. Example: 42.

Example input: `{"post_id":310}`

### `brilliantdirectories_review_create`

Create Review · Write

Create a member review with the given fields. Returns the new record with its review_id.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `review_email` (`string`, required): Email address of the reviewer. Example: bob@example.com.
- `review_name` (`string`, required): Name of the reviewer. Example: Bob Johnson.
- `user_id` (`integer`, required): ID of the member. Get IDs from brilliantdirectories_members_list. Example: 42.
- `rating_overall` (`integer`, optional): Overall rating (1–5). Example: 5.
- `recommend` (`integer`, optional): 1 if reviewer recommends this member. Example: 1.
- `review_description` (`string`, optional): Full review text. Example: Fixed our leak the same day.
- `review_status` (`integer`, optional): Approval status: 0 =Pending, 1 =Approved, 2 =Rejected. Example: 2.
- `review_title` (`string`, optional): Review headline. Example: Fast and professional.

Example input: `{"review_email":"<review_email>","review_name":"<review_name>","user_id":42}`

### `brilliantdirectories_review_update`

Update Review · Write

Update a member review: send its review_id and only the fields to change (empty values are ignored). Returns the updated record. Get IDs from brilliantdirectories_reviews_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `review_id` (`integer`, required): ID of the member review to update. Example: 61.
- `rating_overall` (`integer`, optional): Overall rating (1–5). Example: 5.
- `recommend` (`integer`, optional): 1 if reviewer recommends this member. Example: 1.
- `review_description` (`string`, optional): Full review text. Example: Fixed our leak the same day.
- `review_email` (`string`, optional): Email address of the reviewer. Example: bob@example.com.
- `review_name` (`string`, optional): Name of the reviewer. Example: Bob Johnson.
- `review_status` (`integer`, optional): Approval status: 0 =Pending, 1 =Approved, 2 =Rejected. Example: 2.
- `review_title` (`string`, optional): Review headline. Example: Fast and professional.
- `user_id` (`integer`, optional): ID of the member. Get IDs from brilliantdirectories_members_list. Example: 42.

Example input: `{"review_id":61}`

### `brilliantdirectories_unsubscribe_create`

Create Unsubscribe · Write

Create a unsubscribed email with the given fields. Returns the new record with its id.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `email` (`string`, required): Email address that has unsubscribed required on create. Example: jane@example.com.
- `code` (`string`, optional): Source of unsubscribe: admin , email , or api. Example: ab12cd.
- `definitive` (`integer`, optional): 1 for permanent unsubscribe, 0 for standard. Example: 1.
- `type` (`string`, optional): Type of unsubscribe (e.g. unsubscribe ). Example: 1.

Example input: `{"email":"<email>"}`

### `brilliantdirectories_album_delete`

Delete Album · Destructive

Permanently delete a multi-image post (album) and its associated data. Returns a confirmation message. Get IDs from brilliantdirectories_albums_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `group_id` (`integer`, required): ID of the multi-image post (album) to delete. Example: 77.

Example input: `{"group_id":77}`

### `brilliantdirectories_album_photo_delete`

Delete Album Photo · Destructive

Permanently delete a album photo and its associated data. Returns a confirmation message. Get IDs from brilliantdirectories_album_photos_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `photo_id` (`integer`, required): ID of the album photo to delete. Example: 905.

Example input: `{"photo_id":905}`

### `brilliantdirectories_lead_delete`

Delete Lead · Destructive

Permanently delete a lead and its associated data. Returns a confirmation message. Get IDs from brilliantdirectories_leads_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `lead_id` (`integer`, required): ID of the lead to delete. Example: 201.

Example input: `{"lead_id":201}`

### `brilliantdirectories_member_delete`

Delete Member · Destructive

Permanently delete a member and its associated data. Returns a confirmation message. Get IDs from brilliantdirectories_members_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `user_id` (`integer`, required): ID of the member to delete. Example: 42.
- `delete_images` (`string`, optional): 1 also deletes the member's uploaded image files. Example: 1.

Example input: `{"user_id":42}`

### `brilliantdirectories_post_delete`

Delete Post · Destructive

Permanently delete a single image post and its associated data. Returns a confirmation message. Get IDs from brilliantdirectories_posts_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `post_id` (`integer`, required): ID of the single image post to delete. Example: 310.

Example input: `{"post_id":310}`

### `brilliantdirectories_review_delete`

Delete Review · Destructive

Permanently delete a member review and its associated data. Returns a confirmation message. Get IDs from brilliantdirectories_reviews_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `review_id` (`integer`, required): ID of the member review to delete. Example: 61.

Example input: `{"review_id":61}`

### `brilliantdirectories_unsubscribe_delete`

Delete Unsubscribe · Destructive

Permanently delete a unsubscribed email and its associated data. Returns a confirmation message. Get IDs from brilliantdirectories_unsubscribes_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): ID of the unsubscribed email to delete. Example: 15.

Example input: `{"id":15}`

## Related

Other CRM & Sales connectors ([all 174](/agentkit/connectors/?category=crm-sales)):

- [Salesforce](/agentkit/connectors/salesforce/): Scalekit connector, OAuth, 74 tools
- [HubSpot](/agentkit/connectors/hubspot/): Scalekit connector, OAuth, 457 tools
- [Close](/agentkit/connectors/close/): Scalekit connector, OAuth, 103 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
