Deals API

Deals API A deal is one sales opportunity on your Sales Pipeline board — a title, a value, the stage it sits in, and optionally the contact it belongs to and the team member it is assigned to. This guide covers reading and managing deals over the API. Base URL — https://api.relaytiv.com/v1 Authentication — your API key (see Authentication ) Errors & paging — see Errors & Pagination All examples below show the ?apiKey= query form in cURL and the X-API-Key header in JavaScript and Python — either works on every endpoint. The deal object { "id": "deal_abc123", "title": "Annual plan – Jane's Clinic", "description": "Asked for pricing on the annual plan.", "company": "Jane's Clinic", "stage": "stage-2", "pipeline_id": "default", "value": 4800, "probability": 60, "priority": "high", "status": "open", "source": "whatsapp", "position": 0, "contact_id": "ctc_9f8e7d", "assigned_to": "usr_4a2b", "tags": ["clinic"], "close_date": "2026-10-01T00:00:00.000Z", "created_at": "2026-09-05T09:12:00.000Z", "updated_at": "2026-09-05T09:40:00.000Z", "stage_entered_at": "2026-09-05T09:40:00.000Z" } stage is the id of one of your pipeline stages — read them with GET /pipelines (see Pipelines below). Stage ids are unique across all your pipelines, so pipeline_id is derived from the stage and is read-only: default is your main pipeline, and it is null when the stage no longer exists. Timestamps are ISO 8601. List deals GET /deals — returns the deals on your account, newest first. Query paramet