Get

[POST] .../v1/dealtype/get

Returns CRM deal types with pagination. List CRM deal types for deal creation forms, filters, reporting setup and target configuration workflows. The response returns paged DealType records with next_offset and total, including name, optional description, active flag and last update time. The request body is required and supports filters, limit, offset and ids/search/active fields; filters are evaluated against deal type id, deal type name search and active flag. The caller must have CRM deal type select permission; missing body, denied access, invalid filters, storage errors and lookup errors are returned as HTTP 200 ErrorResult.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.
limit Int32 Optional Requested item count. Non-positive values use the server-defined maximum.
offset Int32 Optional Result set offset. If the value is less than 0, 0 is used.
search String Optional Search by deal type name.

Filterable Fields

Field Type Description
active bool Filter by active flag.
id int Filter by deal type IDs.
name string

Request Example

{
  "filters": [
    {
      "Field": "name",
      "Operator": "Like",
      "Value": "Wholesale"
    },
    {
      "Field": "active",
      "Operator": "Equal",
      "Value": "true"
    }
  ],
  "limit": 50,
  "offset": 0
}

Response Parameters

Name Type Description
next_offset Int32 Offset for the next data page.
ok Boolean Indicates whether the request completed successfully.
result Array of DealType Result array.
total Int64 Total number of result items.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 2,
      "name": "Wholesale deal",
      "description": "Deals with wholesale customers",
      "active": true,
      "last_update": 1712345600
    }
  ],
  "next_offset": 0,
  "total": 1
}