Get leads for office

Get lead statistics for a specific partner agent organization office. This endpoint may not be supported for all Venturu partners.

GET /partner/v1/offices/{officeId}/leads/count

Get leads for office

cURL

curl --request GET \
  --url https://www.venturu.com/api/partner/v1/offices/{officeId}/leads/count \
  --header 'Authorization: Bearer <token>'

200

{
  "status": "success",
  "officeId": 123,
  "officeName": "<string>",
  "totalLeads": 123
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

officeId · string · required

The Venturu ID of the office to get leads for.

Response

200

application/json

Successful response

status · enum<string> · required

Indicates that the request was successful.

Available options: success

officeId · number · required

The Venturu ID of the office.

officeName · string · required

The name of the office.

totalLeads · number · required

The total number of leads for the office.