Overview

The V4MOS.AI Ploomes API gives you the raw records synced from the Ploomes accounts connected to your organization: deals, deal stage history, leads, contacts, pipelines, stages, statuses, origins, loss reasons, fields, users and deletions. 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/ploomes prefix and the same authentication, pagination and response format.

Getting startedCopy Anchor Link

Base URL: https://data.v4mos.ai. Every call requires your API credentials and the organizationId — see Authentication.

1. Connect Ploomes in app.v4mos.ai (Connected accounts) and wait for the first sync.
2. Call any endpoint below with your organizationId, for example GET /v1/ploomes/deals?organizationId=….
3. Every row carries integration_id and integration_name: the connected account it came from. To read a single account, pass that value as integrationId.

Available endpointsCopy Anchor Link

• getDeals/v1/ploomes/dealsOne row per deal: pipeline, stage, status, amount, start/finish dates, origin, owner, contact and originating lead.
• getDeal stage history/v1/ploomes/deal-stage-historyOne row per stage change of a deal: from and to stage, whether it advanced, won or lost, amount and days in the stage.
• getLeads/v1/ploomes/leadsOne row per lead: status, discard reason, owner, person and company.
• getContacts/v1/ploomes/contactsOne row per contact (person or company): type, company, origin, status, owner and originating lead.
• getPipelines/v1/ploomes/pipelinesOne row per pipeline, with an archived flag.
• getStages/v1/ploomes/stagesOne row per pipeline stage, with its order.
• getDeal statuses/v1/ploomes/deal-statusesOne row per deal status (open, won, lost).
• getOrigins/v1/ploomes/originsOne row per contact and deal origin.
• getLoss reasons/v1/ploomes/loss-reasonsOne row per deal loss reason, with its pipeline.
• getFields/v1/ploomes/fieldsOne row per field definition, with its entity and type.
• getUsers/v1/ploomes/usersOne row per user of the account: profile, integration and suspended flags.
• getDeleted deals/v1/ploomes/deleted-dealsOne row per deal deleted in Ploomes; use it to drop those deals from your copy.
• getDeleted contacts/v1/ploomes/deleted-contactsOne row per contact deleted in Ploomes; use it to drop those contacts from your copy.

ResourcesCopy Anchor Link

Pagination and filtersCopy Anchor Link

• page (default 1) and limit (default 500, max 5000). meta.hasNextPage says whether another page exists; rows come in a stable order, so walk the pages until it is false.
• dateFrom / dateTo (YYYY-MM-DD, inclusive) filter by the date column shown in the table above. Resources without one reject them.
• integrationId keeps the rows of one connected account.
• Answers are cached for 30 minutes and the data is synced once a day — see Data sync.

Response formatCopy Anchor Link

{
  "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.