Deals

List deals.

get/deals

Request

  • Base URL: https://api.relmcrm.com/v1
  • URL: https://api.relmcrm.com/v1/deals
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.relmcrm.com/oauth/authorize, token URL https://api.relmcrm.com/oauth/token, scopes: crm)

Query parameters

limitinteger

Page size (default 25, max 100).

cursorstring

Opaque keyset cursor from a prior next_cursor.

include_deletedboolean

Include soft-deleted rows.

qstring
pipelinestring

Scope to ONE pipeline (key or pl_ id). Omit and you get deals from ALL pipelines merged - pass this whenever you reason about a single funnel, since stage keys are not unique across pipelines. Alias: pipeline_id.

pipeline_idstring
stagestring
company_idstring
primary_contact_idstring

Response

Deal list

object'list'
has_moreboolean
next_cursorstring nullable

Example response

{
  "data": [
    {
      "id": "deal_..."
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.