Secure API
Learn to set up and use Unificus's Secure API for seamless integrations and data synchronization.
How Do I Use Secure API?
Navigate to the Flyout Menu and select Integrations.
At the top of the Integrations page, choose Secure API.
Authentication Information
Your Authentication Information is displayed on this page, providing everything you need to connect and manage your API access.
Live Documentation: A fully white-labeled reference guide accessible to anyone without login credentials. It includes connection instructions and lets you test your API integration directly.
CLICK HERE to view the Live API Documentation
API Limits: Your account has monthly API call limits based on your subscription tier. Unificus tracks your usage in real time so you always know your remaining quota.
Free Trial = 80 calls/month | Start = 400 calls/month | Thrive = 2,000 calls/month | Pinnacle = 20,000 calls/month
API Authorization Credentials: Access your Public ID and Secret Key(s) from this section.
To create additional Secret Keys, click + Add Secret Key, enter a name, and select Save.
Use the icons next to each key to copy or delete as needed.
Who Can Access Secure API?
By default, Super Admins and Admins can view Secure API. To restrict access to Super Admins only, go to Flyout Menu > Platform Branding. Under White Label Visibility, enable the appropriate setting.
Once enabled, Admin users will no longer see Secure API in the Integrations menu.
CLICK HERE to learn more about Platform Branding
How Do I Use the Live Documentation?
Begin by authenticating with your API credentials from Integrations > Secure API.
Click the green Authorize button and enter your Public ID along with one of your Secret Keys. Once authenticated, you’ll have access to the complete schema of Meta Attributes.
Next, extract your account’s Custom Data schema using the GET /contact/meta endpoint. Open the GET /contact/meta section and locate the Try it out button on the right. Select it, then click Execute.
The response contains the complete schema for all CRM Company and Contact Custom Fields, Project Custom Fields, Marketing Audience subscriptions, and Meta Attributes your team needs for API integration.
Download the full response as a JSON file using the button at the bottom right of the response window. Share this with your development team for reference.
With the schema in hand, use GET, POST, and PUSH endpoints to establish complete two-way data synchronization.
How do I test it?
Once authenticated in the Live Documentation, you can run tests directly against your live database.
Each endpoint includes a Try it out button that opens a data entry field. Configure your API calls here to connect to the Secure API Endpoint and make real-time database changes. These updates appear immediately in your account, so verify you understand each call’s impact before executing.
For safer testing without live credentials, use test credentials on endpoints marked ”* dummy request allowed” in the description. Test credentials return randomized sample data:
X-Public-ID: 00000000-0000-0000-0000-000000000000
X-Secret-Key: DummySecretKey
Behavior Settings
Configure how your API handles missing or unknown items.
Fail the request: The API returns an error response when no matching item is found.
Treat as successful: The API marks the request as successful even if no item exists. This setting is recommended for automation platforms like Pabbly, Zapier, and Make, which interpret non-successful responses as failures.