Skip to main content
GET
/
v1
/
crm
/
leads
/
{leadId}
/
pricing-rules
List Pricing Rules
curl --request GET \
  --url https://api.example.com/v1/crm/leads/{leadId}/pricing-rules \
  --header 'Authorization: Bearer <token>'
{
  "meta": {
    "totalCount": 123,
    "totalPages": 123,
    "page": 123,
    "perPage": 123
  },
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "parentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "pricingItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "locked": true,
      "percent": 123,
      "perItem": 123,
      "cost": 123,
      "billMonths": [],
      "split": 123,
      "bonusAmount": 123,
      "triggerAmount": 123,
      "bonusCalculate": 123,
      "residual": 123,
      "startDate": "2023-12-25",
      "endDate": "2023-12-25",
      "createdAt": "<string>",
      "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "updatedAt": "<string>",
      "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "item": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "key": "<string>",
        "name": "<string>",
        "description": "<string>"
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

Enter token in following format: Bearer

Path Parameters

leadId
string
required

Query Parameters

q
string
size
number
default:20
page
number
default:1
sort
string
default:-createdAt
filter
object
expand
searchable
string[]
before
object
after
object

Response

The paginated list of pricing rules.

meta
object
required
data
object[]
required