Deals

Fetch a deal.

get/deals/{id}

Request

  • Base URL: https://api.relmcrm.com/v1
  • URL: https://api.relmcrm.com/v1/deals/{id}
  • 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)

Response

Deal

idstring
object'deal'
titlestring
value_centsinteger nullable

Integer minor units (cents).

currencystring
pipelinestring nullable

Pipeline KEY. Every deal carries its pipeline - group/filter by (pipeline, stage), never by stage alone (stage keys are not unique across pipelines).

pipeline_namestring nullable

Human display name of the pipeline.

stagestring nullable

Stage KEY within this deal's pipeline.

stage_labelstring nullable

Human display label of the stage.

stage_type'open' | 'won' | 'lost' | 'null' nullable

Semantic stage type - use this for won/lost, cross-pipeline, instead of string-matching the key.

company_idstring nullable
primary_contact_idstring nullable
close_datestring nullable
custom_fieldsobject
versioninteger
modestring
created_atstring
updated_atstring
deletedboolean

Example response

{
  "id": "deal_..."
}

Changes

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