Ploomes
Deals
GET
One row per deal: pipeline, stage, status, amount, start/finish dates, origin, owner, contact and originating lead.
dateFrom and dateTo filter by create_date (inclusive days, YYYY-MM-DD).
Rows are sorted by id, integration_id, inserted_at and paginated with page/limit; meta.hasNextPage says whether another page exists.
Responses are cached for 30 minutes.
ClientIdAuthClientSecretAuthheader
x-client-id<token>Client ID
header
x-client-secret<token>Client secret
organizationId*stringOrganization that owns the connected accounts.
Format
uuidintegrationId?stringOne connected account of this integration (integration_id of the rows). Omit it to read every account of the organization.
Length
length <= 255dateFrom?stringFirst day (inclusive) of create_date, YYYY-MM-DD.
Format
datedateTo?stringLast day (inclusive) of create_date, YYYY-MM-DD. Must not be before dateFrom.
Format
datepage?integerPage number, starting at 1.
Range
1 <= value <= 1000000Default
1limit?integerRows per page (max 5000).
Range
1 <= value <= 5000Default
500One page of rows
application/json- response
data*array<>meta*curl -X GET "https://example.com/v1/ploomes/deals?organizationId=3f2b8c1e-5d4a-4e6f-9a7b-1c2d3e4f5a6b&dateFrom=2026-10-01&dateTo=2026-10-31"{ "data": [ { "organization_id": "3f2b8c1e-5d4a-4e6f-9a7b-1c2d3e4f5a6b", "integration_id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d", "user_id": "123456", "document_id": "123456", "integration_name": "example", "id": "123456", "pipeline_id": "123456", "stage_id": "123456", "status_id": "123456", "last_stage_id": "123456", "loss_reason_id": "123456", "origin_id": "123456", "owner_id": "123456", "creator_id": "123456", "contact_id": "123456", "person_id": "123456", "amount": "125.50", "currency_id": "123456", "start_date": "2026-10-01T12:00:00.000Z", "finish_date": "2026-10-01T12:00:00.000Z", "lead_id": "123456", "origin_deal_id": "123456", "days_in_stage": "1250", "create_date": "2026-10-01T12:00:00.000Z", "last_update_date": "2026-10-01T12:00:00.000Z", "inserted_at": "2026-10-01T12:00:00.000Z" } ], "meta": { "page": 1, "limit": 500, "hasNextPage": false, "hasPreviousPage": false }}