Skip to content
API reference

Every endpoint, written out.

Generated from the live API, so it is exactly what the API accepts today: 299 operations in 42 groups, each with its parameters, request body and the permission it needs.

Groups

GroupWhat it is forOperations
API keysKeys for your own systems and what each may do.5
Ad routingWhose campaign is whose, and the leads waiting for an owner (agencies).12
Ad spendWhat was spent per channel and campaign.5
AgencyClients, their teams and agency-wide views.27
AreasLocalities leads are interested in.2
AttributionHow leads from each channel turn into customers.4
Automation rulesRules that act when something happens.6
AutomationsAutomation runs.6
BillingPlan, usage and invoices of a workspace.9
CampaignsWhich campaign, ad set and ad each lead came from.4
ContactsThe people behind leads: one person, one record, however many enquiries.11
Custom fieldsExtra fields on leads.4
DashboardNumbers for the dashboard.3
FilesPictures and documents.2
HomeWhat needs attention now.1
InvitationsInviting people to a workspace.2
Lead sourcesWhere leads come from (Meta, Google, websites, WhatsApp, your own systems), their Facebook Pages, and the delivery log.15
LeadsCreate, find, assign and move leads, and log what happens on them.29
Live updatesWhat changed since you last looked.1
Message templatesReusable messages.5
MessagingWhatsApp and e-mail from inside the CRM.6
MonitorHealth and audit information for a workspace.6
NotificationsIn-app notifications.3
Outgoing webhooksSigned notifications of what happens in a workspace.10
PipelinesStages, transitions and the board.15
ProjectsDevelopments and the kinds of home in them (real estate).12
PropertiesUnits and listings (real estate).13
Property matchingProperties that suit a lead.1
PublicEndpoints that need no sign-in.1
Push notificationsNotifications on a phone or computer.5
ReportsNumbers for dashboards and exports.4
ReservationsOffers, reservations and sales on units.9
Saved viewsSaved list filters.4
SearchOne box for leads, contacts and properties.1
ShortlistProperties shortlisted for a lead.4
Sign-inSign-up, sign-in and password reset (for the app, not for API keys).9
TasksFollow-ups, calls and meetings.10
TeamPeople in a workspace and their roles.6
Unit typesKinds of home in a project.4
ViewingsSite visits and their feedback.10
WorkspaceThe workspace itself.2
Your accountThe signed-in person.11

The basics

The base URL is https://crm.anibrosdesign.com/api/v1. Send an API key as Authorization: Bearer crm_live_…. Every response is { "data": … }; lists add page.next. Errors are RFC 9457 problem documents. Read the guide for authentication, pagination, errors, idempotency, lead intake and webhooks.

Each operation names the permission it needs. A key can do only what its scopes allow, and only inside its own workspace.

Download

The same description as an OpenAPI 3.1 file (https://crm.anibrosdesign.com/api/v1/openapi.json). Import it into Postman, Insomnia or Bruno, or generate a client library for your language with any OpenAPI generator.

Something missing or unclear? Tell us.

Chat on WhatsApp