Overview
Salesforce data synced to V4MOS.AI, through the integration's own endpoints
The V4MOS.AI Salesforce API gives you the raw records synced from the Salesforce accounts connected to your organization: opportunities, opportunity history, opportunity stages, leads and contacts. Rows come as they were synced, with the warehouse column names (snake_case), so you can load them straight into your BI. All endpoints use the /v1/salesforce prefix and the same authentication, pagination and response format.
Getting started
Base URL: https://data.v4mos.ai. Every call requires your API credentials and the organizationId — see Authentication.
- Connect Salesforce in app.v4mos.ai (Connected accounts) and wait for the first sync.
- Call any endpoint below with your
organizationId, for exampleGET /v1/salesforce/opportunities?organizationId=…. - Every row carries
integration_idandintegration_name: the connected account it came from. To read a single account, pass that value asintegrationId.
Available endpoints
- getOpportunities
/v1/salesforce/opportunitiesOne row per opportunity: stage, amount, probability, close date, won/closed flags, account, contact, campaign and lead source. - getOpportunity history
/v1/salesforce/opportunity-historyOne row per change recorded on an opportunity: stage, amount, probability and close date after the change. - getOpportunity stages
/v1/salesforce/opportunity-stagesOne row per opportunity stage configured in the org: label, order, closed/won flags and default probability. - getLeads
/v1/salesforce/leadsOne row per lead: status, lead source and conversion (date, contact and opportunity). - getContacts
/v1/salesforce/contactsOne row per contact, with its account and lead source.
Resources
| Endpoint | What one row is | dateFrom / dateTo filter |
|---|---|---|
GET /v1/salesforce/opportunities | One row per opportunity: stage, amount, probability, close date, won/closed flags, account, contact, campaign and lead source. | created_date |
GET /v1/salesforce/opportunity-history | One row per change recorded on an opportunity: stage, amount, probability and close date after the change. | created_date |
GET /v1/salesforce/opportunity-stages | One row per opportunity stage configured in the org: label, order, closed/won flags and default probability. | system_modstamp |
GET /v1/salesforce/leads | One row per lead: status, lead source and conversion (date, contact and opportunity). | created_date |
GET /v1/salesforce/contacts | One row per contact, with its account and lead source. | created_date |
Pagination and filters
page(default 1) andlimit(default 500, max 5000).meta.hasNextPagesays whether another page exists; rows come in a stable order, so walk the pages until it isfalse.dateFrom/dateTo(YYYY-MM-DD, inclusive) filter by the date column shown in the table above. Resources without one reject them.integrationIdkeeps the rows of one connected account.- Answers are cached for 30 minutes and the data is synced once a day — see Data sync.
Personal data
Some Salesforce resources carry personal data of your customers and contacts (such as email). Store and process it according to the LGPD and your own privacy policy.
Response format
{
"data": [{ "...": "one object per row, with the columns listed on each endpoint" }],
"meta": {
"page": 1,
"limit": 500,
"hasNextPage": true,
"hasPreviousPage": false
}
}Amounts and large counters (fields with format: decimal or format: int64 in each endpoint schema) come as strings, e.g. "125.50", so no precision is lost. Convert them to a decimal type on your side.