Deal
List all existing deals
get/v1/deals
Request
- Base URLhttps://api.infoset.app (the document declares no server; this is the origin it was published from)
- Auth
- HTTP bearer
- or API key in header X-Api-Key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
Idinteger
PipelineIdinteger
StageIdinteger
StageIdsinteger[]
Namestring
Contentstring
Notesstring
FromValuenumber double
ToValuenumber double
Sourceinteger
StatusDeal
ContactIdinteger
ContactEmailstring
CompanyIdinteger
CreatedUserIdinteger
OwnerUserIdinteger
OwnerGroupIdinteger
FollowerIdsstring
CategoryIdsstring
Currencystring
LostReasonstring
IsSpaminteger
FromDatestring
'yyyy-MM-ddTHH:mm:ss.000Z'
ToDatestring
'yyyy-MM-ddTHH:mm:ss.000Z'
FromUpdatedDatestring
ToUpdatedDatestring
FromClosingDatestring
ToClosingDatestring
FromExpectedCloseDatestring
ToExpectedCloseDatestring
CustomFieldsobject
Qstring
Fieldsstring
DepartmentScopeDepartment
Selects departments for a page-level query. The query-string value can be all or a comma-separated list of positive department IDs, such as 12,34.
ItemsPerPageinteger
ViewType0 | 1
<p>Enum values:</p><ul><li><i>0 = List</i></li><li><i>1 = Kanban</i></li></ul>
<p>Enum values:</p><ul><li><i>0 = List</i></li><li><i>1 = Kanban</i></li></ul><p>Enum values:</p><ul><li><i>0 = List</i></li><li><i>1 = Kanban</i></li></ul>
Pageinteger
ReturnTotalItemsboolean
sortColstring
sortDirstring
isExportboolean
Response
OK
Changes
No recorded changes to this operation across all 3 revisions of this API.