API Access
Learn how to request API access for Scarlett Origination and integrate with third-party services. Review the access approval process, security requirements, and resources available to developers.
Obtaining Access Key
As part of our ongoing commitment to protecting the sensitive client and business information entrusted to our platform, we have introduced a formal review and approval process for API access requests.
We recognize the importance of allowing agents to connect their preferred tools and services. At the same time, we have a responsibility to ensure that integrations accessing information through Scarlett meet appropriate security and privacy standards.
To proceed, please complete our API Access Request Form using the link below:
The form will help us understand the intended use of the integration, the platforms involved, and any associated security or privacy considerations.
Once submitted, our team will review your request and follow up with you. Additional information may be required before access can be approved.
Thank you for your understanding and cooperation as we work to support secure, reliable integrations while protecting your business and client information.
Developer Help Library
Our API Help library can be found here: https://api.scarlettnetwork.net/help
Some of the more common functions are found below.
Endpoints
https://api.scarlettnetwork.com
Pull
POST /dosconnect/deal-pull
Body
Parameter | Data type | Description |
APIKey | string |
|
From | Date | Last modified date |
To | Date | YYYY-MM-DD, 7 days |
Response
Parameter | Data Type | Description |
ReturnStatus.ReturnCode | Int | HTTP Status |
Deals | List<deal model> |
Push
POST /dosconnect/deal-push
Body
Parameter | Data Type | Description |
APIKey | String |
|
FirmCode | String |
|
ExpertLogin | String |
|
Deal | Deal model |
Dropdowns
Post /dosconnect/dropdown-pull
Body
Parameter | Data Type | Description |
APIKey | String |
|
Sample Code
Sample Code to Push Leads Using API