v1

latestOpenAPI 3.1.02026-08-0612447737.4 KB

Deal

List Deals

Retrieve a list of deals

get/deal

Query parameters

idstring

created_atstring

updated_atstring

Latest update

organisation_idstring

Organisation ID

contact_idstring

Contact ID

namestring

Name of the deal

external_idstring

External ID

type_keystring

Type Key

status_keystring

Status Key

assignee_idstring

Assignee ID

valuestring

Value of the deal

currencystring

Currency of the deal

won_atstring

Won at timestamp

lost_atstring

Lost at timestamp

selectstring

Filtering Columns

orderstring

Ordering. Allowed Fields: lost_at, won_at

offsetstring

Limiting and Pagination

limitstring

Limiting and Pagination

Headers

Rangestring

Limiting and Pagination

Range-Unitstring

Limiting and Pagination

Response

OK

idstring uuid

created_atstring timestamp with time zone

updated_atstring timestamp with time zone

Latest update

organisation_idstring uuid

Organisation ID

contact_idstring uuid

Contact ID

namestring text

Name of the deal

external_idstring text nullable

External ID

type_keystring text

Type Key

status_keystring text

Status Key

assignee_idstring uuid nullable

Assignee ID

valuenumber nullable

Value of the deal

currency'EUR' | 'CHF' | 'USD' public.currency

Currency of the deal

won_atstring timestamp with time zone nullable

Won at timestamp

lost_atstring timestamp with time zone nullable

Lost at timestamp