Overview

The V4MOS.AI CRM V4 API exposes lead, opportunity, company, contact, and pipeline data synced from the V4 CRM (mars-sales) connected to your organization. Endpoints share the /v1/crm-v4 prefix and use the same authentication, pagination, and metadata envelope as every other V4MOS.AI integration.

Available EndpointsCopy Anchor Link

• getLeads/v1/crm-v4/leadsRetrieve CRM V4 leads with stage, temperature, owner, and lifecycle timestamps.
• getOpportunities/v1/crm-v4/opportunitiesRetrieve CRM V4 opportunities with stage, deal amount, owner, and lifecycle timestamps.
• getCompanies/v1/crm-v4/companiesRetrieve CRM V4 companies with segment, revenue tier, owner, and activity data.
• getContacts/v1/crm-v4/contactsRetrieve CRM V4 contacts with their primary company and owner.
• getPipelines/v1/crm-v4/pipelinesRetrieve CRM V4 pipeline stages — one row per board/column pair, ordered by board and stage position.

AuthenticationCopy Anchor Link

All endpoints require the x-client-id and x-client-secret headers, plus the organizationId query parameter. See Authentication.

Common ParametersCopy Anchor Link

• organizationId (required) – Organization that owns the CRM V4 integration
• integrationId – Integration scope
• page – Page number (default: 1)
• limit – Records per page (default: 500, max: 5000)

Resource-Specific FiltersCopy Anchor Link

Leads (/v1/crm-v4/leads)Copy Anchor Link

• boardId, columnId, phaseType – Pipeline and stage filters
• temperature, ownerId
• createdStart / createdEnd – Creation date range

Opportunities (/v1/crm-v4/opportunities)Copy Anchor Link

• boardId, columnId, phaseType – Pipeline and stage filters
• type – Board type (OPPORTUNITY, EXPANSION, ACQUISITION)
• ownerId
• createdStart / createdEnd – Creation date range

Companies (/v1/crm-v4/companies)Copy Anchor Link

• segment, tierType, ownerId
• lastActivityStart / lastActivityEnd – Last activity range

Contacts (/v1/crm-v4/contacts)Copy Anchor Link

• companyId, ownerId

Pipelines (/v1/crm-v4/pipelines)Copy Anchor Link

• boardId
• boardType – Board type (LEAD, OPPORTUNITY, EXPANSION, ACQUISITION)

Working With StagesCopy Anchor Link

A card's stage is described by column_id + column_title + phase_type. Use phase_type for business logic — it is the stable, language-independent marker, while column_title is free text organizations can rename at any time. Join cards to /v1/crm-v4/pipelines on board_id + column_id to resolve stage ordering (column_order).

PaginationCopy Anchor Link

Responses return meta.page, meta.limit, meta.hasNextPage, and meta.hasPreviousPage. Iterate while hasNextPage is true.