Brokeredge API Key

API Keys allow you to connect Brokeredge to third-party applications, AI assistants, automation platforms, and custom software.

Before You Begin

Treat your API key like a password.

  • Never share your API key.
  • Only use trusted applications and services.
  • Revoke and regenerate your key immediately if you believe it has been compromised.

Any application with your API key may be able to access data within your Brokeredge account.

Before connecting a third-party service, review its privacy policy and security practices. Brokeredge does not control or monitor how third-party applications store, process, share, or use your data once access has been authorized.

Important Note on Data Logic Flow

The API provides direct access to Brokeredge data. Brokeredge contains extensive workflow logic, automations, validations, and record relationships that may not be triggered when records are created, updated, or deleted through the API.

A successful API request does not necessarily produce the same result as performing the same action within Brokeredge. Users are responsible for understanding any workflow, automation, validation, or data dependencies before using POST, PUT, or DELETE operations.

Brokeredge is not responsible for data that is created, modified, deleted, corrupted, or otherwise affected as a result of third-party applications, AI agents, automation platforms, custom integrations, user actions, or misuse of an API key.

Support Limitations

API access is self-supported.

Brokeredge Support can assist with API availability and documentation.

Brokeredge does not provide support for custom code, AI agents, prompts, third-party applications, automation workflows, integration troubleshooting, or custom development.

You are responsible for the setup and maintenance of any software connected to Brokeredge using your API key.

How API Authentication Works

Brokeredge uses Bearer Token authentication.

Include your API key in the Authorization  header of each request:

Authorization: Bearer YOUR_API_KEY

Supported Request Types

The Brokeredge API supports standard REST methods:

  • GET – Retrieve data
  • POST – Create records
  • PUT – Update records
  • DELETE – Remove records

API Overview

The Brokeredge API uses JSON for all requests and responses.

Base URL

https://brokeredge.api.rulyapp.com/{endpoint}

Replace {endpoint}  with the model you wish to access.

Examples:

https://brokeredge.api.rulyapp.com/contact https://brokeredge.api.rulyapp.com/mortgage https://brokeredge.api.rulyapp.com/tasks

Supported Methods

GET - Retrieve Records

Retrieve a list or a single record from a model.

GET /contact 
or 
GET /contact/{id}

You may filter and select specific fields.

Examples:

GET /contact?Filters=LastName::Smith 
GET /contact?Filters=Email::john@example.com 
GET /contact?Fields=FirstName,LastName,Email

POST - Create Records

Create a new record by submitting JSON in the request body.

POST /contact

All required fields for the model must be included.

Example:

{  "FirstName": "John",  "LastName": "Smith",  "Email": "john@example.com" }

PUT - Update Records

Update an existing record by submitting JSON in the request body.

PUT /contact

The record Id is required.

If the record does not exist, the request will fail.

Example:

{  "Id": 123,  "Email": "newemail@example.com" }

If you do not know the Id, first perform a GET request to locate the record.

DELETE - Delete Records

Delete a record using its Id.

DELETE /contact/123

The Id must be included in the URL.

Searching & Filtering

The API supports filtering records using the Filters  parameter.

Exact Match

Filters=Email::john@example.com

Multiple Values

Filters=Status::[Active;Pending]

Not Equal

Filters=Status!:Closed

Greater Than / Less Than

Filters=Amount>:500000 Filters=Amount<:1000000

Greater Than or Equal / Less Than or Equal

Filters=Amount>:::500000 Filters=Amount<::1000000

Contains (Wildcard Search)

Filters=LastName:::Smith

Returns records where the field contains the supplied value.

Multiple Conditions

AND:

Filters=Province::BC;Status::Active

OR:

Filters=(Province::BC,Province::AB)

Field Selection

By default, all fields are returned.

To return specific fields:

Fields=FirstName,LastName,Email

Linked fields are also supported:

Fields=Applicant.FirstName,Applicant.LastName

Sorting

Sort=LastName|asc Sort=CreatedDate|desc

Pagination

PageSize=100 Page=0

Maximum page size is 1000 records.

Notes

  • All requests and responses use JSON.
  • POST requests must include all required fields.
    • A successful POST request indicates the record was created, but does not guarantee all related Brokeredge workflows or automations were executed.
  • PUT requests require the record Id.
  • DELETE requests require the record Id in the URL.
  • Record Ids can be obtained using a GET request.
  • API access is subject to your Brokeredge permissions.
  • When populating linked records (for example Mortgage.Applicant), the linked record's Id must be supplied rather than a name or other field value.

Required fields are indicated by an asterisk (*) within the Brokeredge user interface and must be supplied when creating records through the API:

Creating an API Key

  1. Navigate to Settings and enable Third Party Integrations.
  2. Review and acknowledge the Terms of Use.
  3. Once enabled, an API Keys tab will appear at the top of the page.
  4. Click API Keys and select Create New Key.
  5. Enter a name for the key and select an expiry date (up to 6 months from today).
  6. Save the key and securely store it. Your API key should be treated like a password.

Important Notes

  • Only one active API key is permitted per account.
  • API keys can expire up to 6 months from the date they are created.
  • Brokeredge will send an email reminder 1 week before expiry.
  • When a key expires, create a new key and update any connected applications with the new value.